

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Object mask (lv_objmask) &mdash; LVGL  documentation</title>
  

  
  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
  <link rel="stylesheet" href="../_static/css/fontawesome.min.css" type="text/css" />

  
  
    <link rel="shortcut icon" href="../_static/favicon.png"/>
  
  
  

  
  <!--[if lt IE 9]>
    <script src="../_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
        <script src="../_static/jquery.js"></script>
        <script src="../_static/underscore.js"></script>
        <script src="../_static/doctools.js"></script>
    
    <script type="text/javascript" src="../_static/js/theme.js"></script>

    
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="Page (lv_page)" href="page.html" />
    <link rel="prev" title="Message box (lv_msgbox)" href="msgbox.html" />
 
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-78811084-3"></script>
<script>
  window.dataLayer = window.dataLayer || [];
  function gtag(){dataLayer.push(arguments);}
  gtag('js', new Date());

	gtag('config', 'UA-78811084-3', { 'anonymize_ip': true });
</script>

</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

          
            <a href="../index.html">
          

          
            
            <img src="../_static/logo_lvgl.png" class="logo" alt="Logo"/>
          
          </a>

          
            
            
              <div class="version">
                v7.11.0-dev
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        
        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../intro/index.html">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../intro/index.html#key-features">Key features</a></li>
<li class="toctree-l2"><a class="reference internal" href="../intro/index.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="../intro/index.html#license">License</a></li>
<li class="toctree-l2"><a class="reference internal" href="../intro/index.html#repository-layout">Repository layout</a></li>
<li class="toctree-l2"><a class="reference internal" href="../intro/index.html#release-policy">Release policy</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#branches">Branches</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#release-cycle">Release cycle</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#tags">Tags</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#changelog">Changelog</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#side-projects">Side projects</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#version-support">Version support</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../intro/index.html#faq">FAQ</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#where-can-i-ask-questions">Where can I ask questions?</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#is-my-mcu-hardware-supported">Is my MCU/hardware supported?</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#is-my-display-supported">Is my display supported?</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#nothing-happens-my-display-driver-is-not-called-what-have-i-missed">Nothing happens, my display driver is not called. What have I missed?</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#why-the-display-driver-is-called-only-once-only-the-upper-part-of-the-display-is-refreshed">Why the display driver is called only once? Only the upper part of the display is refreshed.</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#why-i-see-only-garbage-on-the-screen">Why I see only garbage on the screen?</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#why-i-see-non-sense-colors-on-the-screen">Why I see non-sense colors on the screen?</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#how-to-speed-up-my-ui">How to speed up my UI?</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#how-to-reduce-flash-rom-usage">How to reduce flash/ROM usage?</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#how-to-reduce-the-ram-usage">How to reduce the RAM usage</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#how-to-work-with-an-operating-system">How to work with an operating system?</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../get-started/index.html">Get started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../get-started/quick-overview.html">Quick overview</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../get-started/quick-overview.html#get-started-in-a-simulator">Get started in a simulator</a></li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/quick-overview.html#add-lvgl-into-your-project">Add LVGL into your project</a></li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/quick-overview.html#learn-the-basics">Learn the basics</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/quick-overview.html#widgets">Widgets</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/quick-overview.html#events">Events</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/quick-overview.html#parts">Parts</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/quick-overview.html#states">States</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/quick-overview.html#styles">Styles</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/quick-overview.html#themes">Themes</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/quick-overview.html#examples">Examples</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/quick-overview.html#button-with-label">Button with label</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/quick-overview.html#styling-buttons">Styling buttons</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/quick-overview.html#slider-and-alignment">Slider and alignment</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/quick-overview.html#micropython">Micropython</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../get-started/pc-simulator.html">Simulator on PC</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../get-started/pc-simulator.html#select-an-ide">Select an IDE</a></li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/pc-simulator.html#set-up-eclipse-cdt">Set-up Eclipse CDT</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/pc-simulator.html#install-eclipse-cdt">Install Eclipse CDT</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/pc-simulator.html#install-sdl-2">Install SDL 2</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/pc-simulator.html#pre-configured-project">Pre-configured project</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/pc-simulator.html#add-the-pre-configured-project-to-eclipse-cdt">Add the pre-configured project to Eclipse CDT</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/pc-simulator.html#compile-and-run">Compile and Run</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../get-started/stm32.html">STM32</a></li>
<li class="toctree-l2"><a class="reference internal" href="../get-started/nxp.html">NXP</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../get-started/nxp.html#creating-new-project-with-lvgl">Creating new project with LVGL</a></li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/nxp.html#adding-hw-acceleration-for-nxp-imx-rt-platforms-using-pxp-pixel-pipeline-engine-for-existing-projects">Adding HW acceleration for NXP iMX RT platforms using PXP (PiXel Pipeline) engine for existing projects</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/nxp.html#features-supported">Features supported:</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/nxp.html#basic-configuration">Basic configuration:</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/nxp.html#basic-initialization">Basic initialization:</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/nxp.html#project-setup">Project setup:</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/nxp.html#advanced-configuration">Advanced configuration:</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../get-started/espressif.html">Espressif (ESP32)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../get-started/espressif.html#get-the-lvgl-demo-project-for-esp32">Get the LVGL demo project for ESP32</a></li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/espressif.html#use-lvgl-in-your-esp32-project">Use LVGL in your ESP32 project</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/espressif.html#prerequisites">Prerequisites</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/espressif.html#get-lvgl">Get LVGL</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/espressif.html#use-lvgl-esp32-drivers-in-your-project">Use lvgl_esp32_drivers in your project</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/espressif.html#support-for-esp32-s2">Support for ESP32-S2</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../get-started/arduino.html">Arduino</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../get-started/arduino.html#get-the-lvgl-ardunio-library">Get the LVGL Ardunio library</a></li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/arduino.html#set-up-drivers">Set up drivers</a></li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/arduino.html#configure-lvgl">Configure LVGL</a></li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/arduino.html#configure-the-examples">Configure the examples</a></li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/arduino.html#initialize-lvgl-and-run-an-example">Initialize LVGL and run an example</a></li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/arduino.html#debugging-and-logging">Debugging and logging</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../get-started/micropython.html">Micropython</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../get-started/micropython.html#what-is-micropython">What is Micropython?</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/micropython.html#highlights-of-micropython">Highlights of Micropython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/micropython.html#why-micropython-lvgl">Why Micropython + LVGL?</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/micropython.html#here-are-some-advantages-of-using-lvgl-in-micropython">Here are some advantages of using LVGL in Micropython:</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/micropython.html#micropython-lvgl-could-be-used-for">Micropython + LVGL could be used for:</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/micropython.html#so-what-does-it-look-like">So what does it look like?</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/micropython.html#a-simple-example">A simple example</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/micropython.html#how-can-i-use-it">How can I use it?</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/micropython.html#online-simulator">Online Simulator</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/micropython.html#pc-simulator">PC Simulator</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/micropython.html#embedded-platform">Embedded platform</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/micropython.html#where-can-i-find-more-information">Where can I find more information?</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../get-started/nuttx.html">NuttX RTOS</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../get-started/nuttx.html#what-is-nuttx">What is NuttX?</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/nuttx.html#highlights-of-nuttx">Highlights of NuttX</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/nuttx.html#why-nuttx-lvgl">Why NuttX + LVGL?</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/nuttx.html#here-are-some-advantages-of-using-lvgl-in-nuttx">Here are some advantages of using LVGL in NuttX</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/nuttx.html#nuttx-lvgl-could-be-used-for">NuttX + LVGL could be used for</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/nuttx.html#how-to-get-started-with-nuttx-and-lvgl">How to get started with NuttX and LVGL?</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/nuttx.html#first-you-need-to-install-the-pre-requisite-on-your-system">First you need to install the pre-requisite on your system</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/nuttx.html#now-let-s-to-create-a-workspace-to-save-our-files">Now let's to create a workspace to save our files</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/nuttx.html#clone-the-nuttx-and-apps-repositories">Clone the NuttX and Apps repositories:</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/nuttx.html#configure-nuttx-to-use-the-stm32f429i-disco-board-and-the-lvgl-demo">Configure NuttX to use the stm32f429i-disco board and the LVGL Demo</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/nuttx.html#flashing-the-firmware-in-the-board-using-openocd">Flashing the firmware in the board using OpenOCD:</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/nuttx.html#where-can-i-find-more-information">Where can I find more information?</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../porting/index.html">Porting</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../porting/sys.html">System overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="../porting/project.html">Set-up a project</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../porting/project.html#get-the-library">Get the library</a></li>
<li class="toctree-l3"><a class="reference internal" href="../porting/project.html#configuration-file">Configuration file</a></li>
<li class="toctree-l3"><a class="reference internal" href="../porting/project.html#initialization">Initialization</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../porting/display.html">Display interface</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../porting/display.html#display-buffer">Display buffer</a></li>
<li class="toctree-l3"><a class="reference internal" href="../porting/display.html#display-driver">Display driver</a></li>
<li class="toctree-l3"><a class="reference internal" href="../porting/display.html#rotation">Rotation</a></li>
<li class="toctree-l3"><a class="reference internal" href="../porting/display.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../porting/indev.html">Input device interface</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../porting/indev.html#types-of-input-devices">Types of input devices</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../porting/indev.html#touchpad-mouse-or-any-pointer">Touchpad, mouse or any pointer</a></li>
<li class="toctree-l4"><a class="reference internal" href="../porting/indev.html#keypad-or-keyboard">Keypad or keyboard</a></li>
<li class="toctree-l4"><a class="reference internal" href="../porting/indev.html#encoder">Encoder</a></li>
<li class="toctree-l4"><a class="reference internal" href="../porting/indev.html#button">Button</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../porting/indev.html#other-features">Other features</a></li>
<li class="toctree-l3"><a class="reference internal" href="../porting/indev.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../porting/tick.html">Tick interface</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../porting/tick.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../porting/task-handler.html">Task Handler</a></li>
<li class="toctree-l2"><a class="reference internal" href="../porting/sleep.html">Sleep management</a></li>
<li class="toctree-l2"><a class="reference internal" href="../porting/os.html">Operating system and interrupts</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../porting/os.html#tasks-and-threads">Tasks and threads</a></li>
<li class="toctree-l3"><a class="reference internal" href="../porting/os.html#interrupts">Interrupts</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../porting/log.html">Logging</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../porting/log.html#log-level">Log level</a></li>
<li class="toctree-l3"><a class="reference internal" href="../porting/log.html#logging-with-printf">Logging with printf</a></li>
<li class="toctree-l3"><a class="reference internal" href="../porting/log.html#custom-log-function">Custom log function</a></li>
<li class="toctree-l3"><a class="reference internal" href="../porting/log.html#add-logs">Add logs</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../overview/index.html">Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../overview/object.html">Objects</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/object.html#attributes">Attributes</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/object.html#basic-attributes">Basic attributes</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/object.html#specific-attributes">Specific attributes</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/object.html#working-mechanisms">Working mechanisms</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/object.html#parent-child-structure">Parent-child structure</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/object.html#moving-together">Moving together</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/object.html#visibility-only-on-the-parent">Visibility only on the parent</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/object.html#create-delete-objects">Create - delete objects</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/object.html#screens">Screens</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/object.html#create-screens">Create screens</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/object.html#get-the-active-screen">Get the active screen</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/object.html#load-screens">Load screens</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/object.html#handling-multiple-displays">Handling multiple displays</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/object.html#parts">Parts</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/object.html#states">States</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/layer.html">Layers</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/layer.html#order-of-creation">Order of creation</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/layer.html#bring-to-the-foreground">Bring to the foreground</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/layer.html#top-and-sys-layers">Top and sys layers</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/event.html">Events</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/event.html#event-types">Event types</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/event.html#generic-events">Generic events</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/event.html#special-events">Special events</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/event.html#custom-data">Custom data</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/event.html#send-events-manually">Send events manually</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/event.html#arbitrary-events">Arbitrary events</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/event.html#refresh-event">Refresh event</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/style.html">Styles</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#states">States</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#cascading-styles">Cascading styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#inheritance">Inheritance</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#parts">Parts</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#initialize-styles-and-set-get-properties">Initialize styles and set/get properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#managing-style-list">Managing style list</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#local-styles">Local styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#transitions">Transitions</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#properties">Properties</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#mixed-properties">Mixed properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#padding-and-margin-properties">Padding and margin properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#background-properties">Background properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#border-properties">Border properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#outline-properties">Outline properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#shadow-properties">Shadow properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#pattern-properties">Pattern properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#value-properties">Value properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#text-properties">Text properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#line-properties">Line properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#image-properties">Image properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#transition-properties">Transition properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#scale-properties">Scale properties</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#themes">Themes</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#extending-themes">Extending themes</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#styling-a-button">Styling a button</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/indev.html">Input devices</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/indev.html#pointers">Pointers</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/indev.html#keypad-and-encoder">Keypad and encoder</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/indev.html#groups">Groups</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/indev.html#styling">Styling</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/indev.html#api">API</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/indev.html#input-device">Input device</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/indev.html#id1">Groups</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/display.html">Displays</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/display.html#multiple-display-support">Multiple display support</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#using-only-one-display">Using only one display</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#mirror-display">Mirror display</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#split-image">Split image</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/display.html#screens">Screens</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#transparent-screens">Transparent screens</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/display.html#features-of-displays">Features of displays</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#inactivity">Inactivity</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#background">Background</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/display.html#colors">Colors</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#convert-color">Convert color</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#swap-16-colors">Swap 16 colors</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#create-and-mix-colors">Create and mix colors</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#opacity">Opacity</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#built-in-colors">Built-in colors</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/display.html#api">API</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#display">Display</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#id1">Colors</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/font.html">Fonts</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/font.html#unicode-support">Unicode support</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/font.html#built-in-fonts">Built-in fonts</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/font.html#normal-fonts">Normal fonts</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/font.html#special-fonts">Special fonts</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/font.html#special-features">Special features</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/font.html#bidirectional-support">Bidirectional support</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/font.html#arabic-and-persian-support">Arabic and Persian support</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/font.html#subpixel-rendering">Subpixel rendering</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/font.html#compress-fonts">Compress fonts</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/font.html#add-new-font">Add new font</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/font.html#add-new-symbols">Add new symbols</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/font.html#load-font-in-run-time">Load font in run-time</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/font.html#add-a-new-font-engine">Add a new font engine</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/image.html">Images</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/image.html#store-images">Store images</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#variables">Variables</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#files">Files</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/image.html#color-formats">Color formats</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/image.html#add-and-use-images">Add and use images</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#online-converter">Online converter</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#manually-create-an-image">Manually create an image</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#use-images">Use images</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/image.html#image-decoder">Image decoder</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#custom-image-formats">Custom image formats</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#register-an-image-decoder">Register an image decoder</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#manually-use-an-image-decoder">Manually use an image decoder</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/image.html#image-caching">Image caching</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#cache-size">Cache size</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#value-of-images">Value of images</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#memory-usage">Memory usage</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#clean-the-cache">Clean the cache</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/image.html#api">API</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#id1">Image decoder</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#image-cache">Image cache</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#image-buffer">Image buffer</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#image-draw">Image draw</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/file-system.html">File system</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/file-system.html#add-a-driver">Add a driver</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/file-system.html#usage-example">Usage example</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/file-system.html#use-drivers-for-images">Use drivers for images</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/file-system.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/animation.html">Animations</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/animation.html#create-an-animation">Create an animation</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/animation.html#animation-path">Animation path</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/animation.html#speed-vs-time">Speed vs time</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/animation.html#delete-animations">Delete animations</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/animation.html#api">API</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/animation.html#input-device">Input device</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/task.html">Tasks</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/task.html#create-a-task">Create a task</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/task.html#ready-and-reset">Ready and Reset</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/task.html#set-parameters">Set parameters</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/task.html#one-shot-tasks">One-shot tasks</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/task.html#measure-idle-time">Measure idle time</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/task.html#asynchronous-calls">Asynchronous calls</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/task.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/drawing.html">Drawing</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/drawing.html#buffering-types">Buffering types</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/drawing.html#mechanism-of-screen-refreshing">Mechanism of screen refreshing</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/drawing.html#masking">Masking</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/drawing.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/drawing.html#micropython">MicroPython</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Widgets</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="obj.html">Base object (lv_obj)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="obj.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="obj.html#coordinates">Coordinates</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#parents-and-children">Parents and children</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#screens">Screens</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#layers">Layers</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#events">Events</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="obj.html#parts">Parts</a><ul>
<li class="toctree-l4"><a class="reference internal" href="obj.html#states">States</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#style">Style</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#attributes">Attributes</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#protect">Protect</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#groups">Groups</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#extended-click-area">Extended click area</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="obj.html#id1">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="obj.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="obj.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="obj.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="obj.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="arc.html">Arc (lv_arc)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="arc.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="arc.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="arc.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="arc.html#angles">Angles</a></li>
<li class="toctree-l4"><a class="reference internal" href="arc.html#rotation">Rotation</a></li>
<li class="toctree-l4"><a class="reference internal" href="arc.html#range-and-values">Range and values</a></li>
<li class="toctree-l4"><a class="reference internal" href="arc.html#type">Type</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="arc.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="arc.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="arc.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="arc.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="arc.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="arc.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="bar.html">Bar (lv_bar)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="bar.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="bar.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="bar.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="bar.html#value-and-range">Value and range</a></li>
<li class="toctree-l4"><a class="reference internal" href="bar.html#modes">Modes</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="bar.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="bar.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="bar.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="bar.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="bar.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="bar.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="btn.html">Button (lv_btn)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="btn.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="btn.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="btn.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="btn.html#states">States</a></li>
<li class="toctree-l4"><a class="reference internal" href="btn.html#checkable">Checkable</a></li>
<li class="toctree-l4"><a class="reference internal" href="btn.html#layout-and-fit">Layout and Fit</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="btn.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="btn.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="btn.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="btn.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="btn.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="btn.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="btnmatrix.html">Button matrix (lv_btnmatrix)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="btnmatrix.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="btnmatrix.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="btnmatrix.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="btnmatrix.html#button-s-text">Button's text</a></li>
<li class="toctree-l4"><a class="reference internal" href="btnmatrix.html#control-buttons">Control buttons</a></li>
<li class="toctree-l4"><a class="reference internal" href="btnmatrix.html#one-check">One check</a></li>
<li class="toctree-l4"><a class="reference internal" href="btnmatrix.html#recolor">Recolor</a></li>
<li class="toctree-l4"><a class="reference internal" href="btnmatrix.html#aligning-the-button-s-text">Aligning the button's text</a></li>
<li class="toctree-l4"><a class="reference internal" href="btnmatrix.html#notes">Notes</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="btnmatrix.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="btnmatrix.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="btnmatrix.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="btnmatrix.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="btnmatrix.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="btnmatrix.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="calendar.html">Calendar (lv_calendar)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="calendar.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="calendar.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="calendar.html#usage">Usage</a></li>
<li class="toctree-l3"><a class="reference internal" href="calendar.html#id1">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="calendar.html#current-date">Current date</a></li>
<li class="toctree-l4"><a class="reference internal" href="calendar.html#shown-date">Shown date</a></li>
<li class="toctree-l4"><a class="reference internal" href="calendar.html#highlighted-days">Highlighted days</a></li>
<li class="toctree-l4"><a class="reference internal" href="calendar.html#name-of-the-days">Name of the days</a></li>
<li class="toctree-l4"><a class="reference internal" href="calendar.html#name-of-the-months">Name of the months</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="calendar.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="calendar.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="calendar.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="calendar.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="calendar.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="calendar.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="canvas.html">Canvas (lv_canvas)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="canvas.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="canvas.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="canvas.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="canvas.html#buffer">Buffer</a></li>
<li class="toctree-l4"><a class="reference internal" href="canvas.html#palette">Palette</a></li>
<li class="toctree-l4"><a class="reference internal" href="canvas.html#drawing">Drawing</a></li>
<li class="toctree-l4"><a class="reference internal" href="canvas.html#transformations">Transformations</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="canvas.html#blur">Blur</a></li>
<li class="toctree-l3"><a class="reference internal" href="canvas.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="canvas.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="canvas.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="canvas.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="canvas.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="canvas.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="checkbox.html">Checkbox (lv_cb)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="checkbox.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="checkbox.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="checkbox.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="checkbox.html#text">Text</a></li>
<li class="toctree-l4"><a class="reference internal" href="checkbox.html#check-uncheck">Check/Uncheck</a></li>
<li class="toctree-l4"><a class="reference internal" href="checkbox.html#disabled">Disabled</a></li>
<li class="toctree-l4"><a class="reference internal" href="checkbox.html#get-set-checkbox-state">Get/Set Checkbox State</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="checkbox.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="checkbox.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="checkbox.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="checkbox.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="checkbox.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="checkbox.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="chart.html">Chart (lv_chart)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="chart.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="chart.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="chart.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="chart.html#data-series">Data series</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#series-type">Series' type</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#modify-the-data">Modify the data</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#override-default-start-point-for-series">Override default start point for series</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#set-an-external-data-source">Set an external data source</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#get-current-chart-information">Get current chart information</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#update-modes">Update modes</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#number-of-points">Number of points</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#vertical-range">Vertical range</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#division-lines">Division lines</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#tick-marks-and-labels">Tick marks and labels</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#cursor">Cursor</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="chart.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="chart.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="chart.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="chart.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="chart.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cont.html">Container (lv_cont)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cont.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="cont.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="cont.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="cont.html#layout">Layout</a></li>
<li class="toctree-l4"><a class="reference internal" href="cont.html#autofit">Autofit</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="cont.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="cont.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="cont.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="cont.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="cont.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="cont.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpicker.html">Color picker (lv_cpicker)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpicker.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpicker.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpicker.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpicker.html#type">Type</a></li>
<li class="toctree-l4"><a class="reference internal" href="cpicker.html#set-color">Set color</a></li>
<li class="toctree-l4"><a class="reference internal" href="cpicker.html#color-mode">Color mode</a></li>
<li class="toctree-l4"><a class="reference internal" href="cpicker.html#knob-color">Knob color</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="cpicker.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpicker.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpicker.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpicker.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="cpicker.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="cpicker.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="dropdown.html">Drop-down list (lv_dropdown)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="dropdown.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="dropdown.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="dropdown.html#usage">Usage</a></li>
<li class="toctree-l3"><a class="reference internal" href="dropdown.html#id1">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="dropdown.html#set-options">Set options</a></li>
<li class="toctree-l4"><a class="reference internal" href="dropdown.html#get-selected-option">Get selected option</a></li>
<li class="toctree-l4"><a class="reference internal" href="dropdown.html#direction">Direction</a></li>
<li class="toctree-l4"><a class="reference internal" href="dropdown.html#symbol">Symbol</a></li>
<li class="toctree-l4"><a class="reference internal" href="dropdown.html#maximum-height">Maximum height</a></li>
<li class="toctree-l4"><a class="reference internal" href="dropdown.html#show-selected">Show selected</a></li>
<li class="toctree-l4"><a class="reference internal" href="dropdown.html#animation-time">Animation time</a></li>
<li class="toctree-l4"><a class="reference internal" href="dropdown.html#manually-open-close">Manually open/close</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="dropdown.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="dropdown.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="dropdown.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="dropdown.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="dropdown.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="dropdown.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="gauge.html">Gauge (lv_gauge)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="gauge.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="gauge.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="gauge.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="gauge.html#set-value-and-needles">Set value and needles</a></li>
<li class="toctree-l4"><a class="reference internal" href="gauge.html#scale">Scale</a></li>
<li class="toctree-l4"><a class="reference internal" href="gauge.html#range">Range</a></li>
<li class="toctree-l4"><a class="reference internal" href="gauge.html#needle-image">Needle image</a></li>
<li class="toctree-l4"><a class="reference internal" href="gauge.html#critical-value">Critical value</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="gauge.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="gauge.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="gauge.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="gauge.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="gauge.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="gauge.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="img.html">Image (lv_img)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="img.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="img.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="img.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="img.html#image-source">Image source</a></li>
<li class="toctree-l4"><a class="reference internal" href="img.html#label-as-an-image">Label as an image</a></li>
<li class="toctree-l4"><a class="reference internal" href="img.html#transparency">Transparency</a></li>
<li class="toctree-l4"><a class="reference internal" href="img.html#palette-and-alpha-index">Palette and Alpha index</a></li>
<li class="toctree-l4"><a class="reference internal" href="img.html#recolor">Recolor</a></li>
<li class="toctree-l4"><a class="reference internal" href="img.html#auto-size">Auto-size</a></li>
<li class="toctree-l4"><a class="reference internal" href="img.html#mosaic">Mosaic</a></li>
<li class="toctree-l4"><a class="reference internal" href="img.html#offset">Offset</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="img.html#transformations">Transformations</a></li>
<li class="toctree-l3"><a class="reference internal" href="img.html#rotate">Rotate</a></li>
<li class="toctree-l3"><a class="reference internal" href="img.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="img.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="img.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="img.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="img.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="img.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="imgbtn.html">Image button (lv_imgbtn)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="imgbtn.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="imgbtn.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="imgbtn.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="imgbtn.html#image-sources">Image sources</a></li>
<li class="toctree-l4"><a class="reference internal" href="imgbtn.html#button-features">Button features</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="imgbtn.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="imgbtn.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="imgbtn.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="imgbtn.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="imgbtn.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="imgbtn.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="keyboard.html">Keyboard (lv_keyboard)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="keyboard.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="keyboard.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="keyboard.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="keyboard.html#modes">Modes</a></li>
<li class="toctree-l4"><a class="reference internal" href="keyboard.html#assign-text-area">Assign Text area</a></li>
<li class="toctree-l4"><a class="reference internal" href="keyboard.html#new-keymap">New Keymap</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="keyboard.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="keyboard.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="keyboard.html#examples">Examples</a><ul>
<li class="toctree-l4"><a class="reference internal" href="keyboard.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="keyboard.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="keyboard.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="label.html">Label (lv_label)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="label.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="label.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="label.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="label.html#set-text">Set text</a></li>
<li class="toctree-l4"><a class="reference internal" href="label.html#line-break">Line break</a></li>
<li class="toctree-l4"><a class="reference internal" href="label.html#long-modes">Long modes</a></li>
<li class="toctree-l4"><a class="reference internal" href="label.html#text-align">Text align</a></li>
<li class="toctree-l4"><a class="reference internal" href="label.html#text-recolor">Text recolor</a></li>
<li class="toctree-l4"><a class="reference internal" href="label.html#very-long-texts">Very long texts</a></li>
<li class="toctree-l4"><a class="reference internal" href="label.html#symbols">Symbols</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="label.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="label.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="label.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="label.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="label.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="label.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="led.html">LED (lv_led)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="led.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="led.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="led.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="led.html#brightness">Brightness</a></li>
<li class="toctree-l4"><a class="reference internal" href="led.html#toggle">Toggle</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="led.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="led.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="led.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="led.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="led.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="led.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="line.html">Line (lv_line)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="line.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="line.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="line.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="line.html#set-points">Set points</a></li>
<li class="toctree-l4"><a class="reference internal" href="line.html#auto-size">Auto-size</a></li>
<li class="toctree-l4"><a class="reference internal" href="line.html#invert-y">Invert y</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="line.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="line.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="line.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="line.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="line.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="line.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="list.html">List (lv_list)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="list.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="list.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="list.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="list.html#add-buttons">Add buttons</a></li>
<li class="toctree-l4"><a class="reference internal" href="list.html#delete-buttons">Delete buttons</a></li>
<li class="toctree-l4"><a class="reference internal" href="list.html#manual-navigation">Manual navigation</a></li>
<li class="toctree-l4"><a class="reference internal" href="list.html#layout">Layout</a></li>
<li class="toctree-l4"><a class="reference internal" href="list.html#edge-flash">Edge flash</a></li>
<li class="toctree-l4"><a class="reference internal" href="list.html#scroll-propagation">Scroll propagation</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="list.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="list.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="list.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="list.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="list.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="list.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="linemeter.html">Line meter (lv_lmeter)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="linemeter.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="linemeter.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="linemeter.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="linemeter.html#set-value">Set value</a></li>
<li class="toctree-l4"><a class="reference internal" href="linemeter.html#range-and-angles">Range and Angles</a></li>
<li class="toctree-l4"><a class="reference internal" href="linemeter.html#angle-offset">Angle offset</a></li>
<li class="toctree-l4"><a class="reference internal" href="linemeter.html#mirror">Mirror</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="linemeter.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="linemeter.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="linemeter.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="linemeter.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="linemeter.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="linemeter.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="msgbox.html">Message box (lv_msgbox)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="msgbox.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="msgbox.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="msgbox.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="msgbox.html#set-text">Set text</a></li>
<li class="toctree-l4"><a class="reference internal" href="msgbox.html#add-buttons">Add buttons</a></li>
<li class="toctree-l4"><a class="reference internal" href="msgbox.html#auto-close">Auto-close</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="msgbox.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="msgbox.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="msgbox.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="msgbox.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="msgbox.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Object mask (lv_objmask)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#adding-mask">Adding mask</a></li>
<li class="toctree-l4"><a class="reference internal" href="#update-mask">Update mask</a></li>
<li class="toctree-l4"><a class="reference internal" href="#remove-mask">Remove mask</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="page.html">Page (lv_page)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="page.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="page.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="page.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="page.html#scrollbars">Scrollbars</a></li>
<li class="toctree-l4"><a class="reference internal" href="page.html#glue-object">Glue object</a></li>
<li class="toctree-l4"><a class="reference internal" href="page.html#focus-object">Focus object</a></li>
<li class="toctree-l4"><a class="reference internal" href="page.html#manual-navigation">Manual navigation</a></li>
<li class="toctree-l4"><a class="reference internal" href="page.html#edge-flash">Edge flash</a></li>
<li class="toctree-l4"><a class="reference internal" href="page.html#scroll-propagation">Scroll propagation</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="page.html#clean-the-page">Clean the page</a><ul>
<li class="toctree-l4"><a class="reference internal" href="page.html#scrollable-api">Scrollable API</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="page.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="page.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="page.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="page.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="page.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="roller.html">Roller (lv_roller)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="roller.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="roller.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="roller.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="roller.html#set-options">Set options</a></li>
<li class="toctree-l4"><a class="reference internal" href="roller.html#get-selected-option">Get selected option</a></li>
<li class="toctree-l4"><a class="reference internal" href="roller.html#align-the-options">Align the options</a></li>
<li class="toctree-l4"><a class="reference internal" href="roller.html#visible-rows">Visible rows</a></li>
<li class="toctree-l4"><a class="reference internal" href="roller.html#animation-time">Animation time</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="roller.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="roller.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="roller.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="roller.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="roller.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="roller.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="slider.html">Slider (lv_slider)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="slider.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="slider.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="slider.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="slider.html#value-and-range">Value and range</a></li>
<li class="toctree-l4"><a class="reference internal" href="slider.html#symmetrical-and-range">Symmetrical and Range</a></li>
<li class="toctree-l4"><a class="reference internal" href="slider.html#knob-only-mode">Knob-only mode</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="slider.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="slider.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="slider.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="slider.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="slider.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="slider.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="spinbox.html">Spinbox (lv_spinbox)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="spinbox.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="spinbox.html#parts-and-styles">Parts and Styles</a><ul>
<li class="toctree-l4"><a class="reference internal" href="spinbox.html#set-format">Set format</a></li>
<li class="toctree-l4"><a class="reference internal" href="spinbox.html#value-and-ranges">Value and ranges</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="spinbox.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="spinbox.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="spinbox.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="spinbox.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="spinbox.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="spinbox.html#api">API</a></li>
<li class="toctree-l3"><a class="reference internal" href="spinbox.html#id1">Example</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="spinner.html">Spinner (lv_spinner)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="spinner.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="spinner.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="spinner.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="spinner.html#arc-length">Arc length</a></li>
<li class="toctree-l4"><a class="reference internal" href="spinner.html#spinning-speed">Spinning speed</a></li>
<li class="toctree-l4"><a class="reference internal" href="spinner.html#spin-types">Spin types</a></li>
<li class="toctree-l4"><a class="reference internal" href="spinner.html#spin-direction">Spin direction</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="spinner.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="spinner.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="spinner.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="spinner.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="spinner.html#id1">MicroPython</a></li>
<li class="toctree-l4"><a class="reference internal" href="spinner.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="spinner.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="switch.html">Switch (lv_switch)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="switch.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="switch.html#parts-and-styles">Parts and Styles</a><ul>
<li class="toctree-l4"><a class="reference internal" href="switch.html#change-state">Change state</a></li>
<li class="toctree-l4"><a class="reference internal" href="switch.html#animation-time">Animation time</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="switch.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="switch.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="switch.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="switch.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="switch.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="switch.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="table.html">Table (lv_table)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="table.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="table.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="table.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="table.html#rows-and-columns">Rows and Columns</a></li>
<li class="toctree-l4"><a class="reference internal" href="table.html#width-and-height">Width and Height</a></li>
<li class="toctree-l4"><a class="reference internal" href="table.html#set-cell-value">Set cell value</a></li>
<li class="toctree-l4"><a class="reference internal" href="table.html#align">Align</a></li>
<li class="toctree-l4"><a class="reference internal" href="table.html#cell-type">Cell type</a></li>
<li class="toctree-l4"><a class="reference internal" href="table.html#merge-cells">Merge cells</a></li>
<li class="toctree-l4"><a class="reference internal" href="table.html#crop-text">Crop text</a></li>
<li class="toctree-l4"><a class="reference internal" href="table.html#scroll">Scroll</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="table.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="table.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="table.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="table.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="table.html#id1">MicroPython</a></li>
<li class="toctree-l4"><a class="reference internal" href="table.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="table.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tabview.html">Tabview (lv_tabview)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tabview.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="tabview.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="tabview.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="tabview.html#adding-tab">Adding tab</a></li>
<li class="toctree-l4"><a class="reference internal" href="tabview.html#change-tab">Change tab</a></li>
<li class="toctree-l4"><a class="reference internal" href="tabview.html#change-tab-s-name">Change tab's name</a></li>
<li class="toctree-l4"><a class="reference internal" href="tabview.html#tab-button-s-position">Tab button's position</a></li>
<li class="toctree-l4"><a class="reference internal" href="tabview.html#animation-time">Animation time</a></li>
<li class="toctree-l4"><a class="reference internal" href="tabview.html#scroll-propagation">Scroll propagation</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="tabview.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="tabview.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="tabview.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="tabview.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="tabview.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="tabview.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="textarea.html">Text area (lv_textarea)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="textarea.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="textarea.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="textarea.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#add-text">Add text</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#placeholder">Placeholder</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#delete-character">Delete character</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#move-the-cursor">Move the cursor</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#hide-the-cursor">Hide the cursor</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#cursor-blink-time">Cursor blink time</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#one-line-mode">One line mode</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#password-mode">Password mode</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#text-align">Text align</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#accepted-characters">Accepted characters</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#max-text-length">Max text length</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#very-long-texts">Very long texts</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#select-text">Select text</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#scrollbars">Scrollbars</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#scroll-propagation">Scroll propagation</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#edge-flash">Edge flash</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="textarea.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="textarea.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="textarea.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="textarea.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tileview.html">Tile view (lv_tileview)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tileview.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileview.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileview.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="tileview.html#valid-positions">Valid positions</a></li>
<li class="toctree-l4"><a class="reference internal" href="tileview.html#set-tile">Set tile</a></li>
<li class="toctree-l4"><a class="reference internal" href="tileview.html#add-element">Add element</a></li>
<li class="toctree-l4"><a class="reference internal" href="tileview.html#scroll-propagation">Scroll propagation</a></li>
<li class="toctree-l4"><a class="reference internal" href="tileview.html#animation-time">Animation time</a></li>
<li class="toctree-l4"><a class="reference internal" href="tileview.html#edge-flash">Edge flash</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="tileview.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileview.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileview.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="tileview.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="tileview.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="tileview.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="win.html">Window (lv_win)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="win.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="win.html#parts-and-styles">Parts and Styles</a><ul>
<li class="toctree-l4"><a class="reference internal" href="win.html#title">Title</a></li>
<li class="toctree-l4"><a class="reference internal" href="win.html#control-buttons">Control buttons</a></li>
<li class="toctree-l4"><a class="reference internal" href="win.html#scrollbars">Scrollbars</a></li>
<li class="toctree-l4"><a class="reference internal" href="win.html#manual-scroll-and-focus">Manual scroll and focus</a></li>
<li class="toctree-l4"><a class="reference internal" href="win.html#layout">Layout</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="win.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="win.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="win.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="win.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="win.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="win.html#api">API</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../contributing/index.html#introduction">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="../contributing/index.html#pull-request">Pull request</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#from-github">From GitHub</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#from-command-line">From command line</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../contributing/index.html#developer-certification-of-origin-dco">Developer Certification of Origin (DCO)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#accepted-licenses-and-copyright-notices">Accepted licenses and copyright notices</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../contributing/index.html#your-own-work">Your own work</a></li>
<li class="toctree-l4"><a class="reference internal" href="../contributing/index.html#use-code-from-online-source">Use code from online source</a></li>
<li class="toctree-l4"><a class="reference internal" href="../contributing/index.html#use-mit-licensed-code">Use MIT licensed code</a></li>
<li class="toctree-l4"><a class="reference internal" href="../contributing/index.html#use-gpl-licensed-code">Use GPL licensed code</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../contributing/index.html#when-you-get-started-with-lvgl">When you get started with LVGL</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#give-lvgl-a-star">Give LVGL a Star</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#tell-what-you-have-achieved">Tell what you have achieved</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#write-examples">Write examples</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#improve-the-docs">Improve the docs</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#translate-the-docs">Translate the docs</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#write-a-blog-post">Write a blog post</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../contributing/index.html#when-you-already-use-lvgl">When you already use LVGL</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#give-feedback">Give feedback</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#report-bugs">Report bugs</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#send-fixes">Send fixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#join-the-conversations-in-the-forum">Join the conversations in the Forum</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#add-features">Add features</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../contributing/index.html#when-you-are-confident-with-lvgl">When you are confident with LVGL</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#become-a-maintainer">Become a maintainer</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#move-your-project-repository-under-lvgl-organization">Move your project repository under LVGL organization</a></li>
</ul>
</li>
</ul>
</li>
</ul>

            
          
        </div>
        
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../index.html">LVGL</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          

















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
        
          <li><a href="index.html">Widgets</a> &raquo;</li>
        
      <li>Object mask (lv_objmask)</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            
              <!-- User defined GitHub URL -->
              <a href="https://github.com/lvgl/docs/blob/latest/widgets/objmask.md" class="fa fa-github"> Edit on GitHub</a>
            
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="object-mask-lv-objmask">
<h1>Object mask (lv_objmask)<a class="headerlink" href="#object-mask-lv-objmask" title="Permalink to this headline">¶</a></h1>
<div class="section" id="overview">
<h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2>
<p>The <em>Object mask</em> is capable of add some mask to drawings when its children is drawn.</p>
</div>
<div class="section" id="parts-and-styles">
<h2>Parts and Styles<a class="headerlink" href="#parts-and-styles" title="Permalink to this headline">¶</a></h2>
<p>The Object mask has only a main part called <code class="docutils literal notranslate"><span class="pre">LV_OBJMASK_PART_BG</span></code> and it uses the typical background style properties.</p>
</div>
<div class="section" id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<div class="section" id="adding-mask">
<h3>Adding mask<a class="headerlink" href="#adding-mask" title="Permalink to this headline">¶</a></h3>
<p>Before adding a mask to the <em>Object mask</em> the mask should be initialized:</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span>    <span class="n">lv_draw_mask_</span><span class="o">&lt;</span><span class="n">type</span><span class="o">&gt;</span><span class="n">_param_t</span> <span class="n">mask_param</span><span class="p">;</span>
    <span class="n">lv_draw_mask_</span><span class="o">&lt;</span><span class="n">type</span><span class="o">&gt;</span><span class="n">_init</span><span class="p">(</span><span class="o">&amp;</span><span class="n">mask_param</span><span class="p">,</span> <span class="p">...);</span>
    <span class="n">lv_objmask_mask_t</span> <span class="o">*</span> <span class="n">mask_p</span> <span class="o">=</span> <span class="n">lv_objmask_add_mask</span><span class="p">(</span><span class="n">objmask</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">mask_param</span><span class="p">);</span>
</pre></div>
</div>
<p>Lvgl supports the following mask types:</p>
<ul class="simple">
<li><p><strong>line</strong> clip the pixels on the top/bottom left/right of a line. Can be initialized from two points or a point and an angle:</p></li>
<li><p><strong>angle</strong> keep the pixels only between a given start and end angle</p></li>
<li><p><strong>radius</strong> keep the pixel only inside a rectangle which can have radius (can for a circle too). Can be inverted to keep the pixel outside of the rectangle.</p></li>
<li><p><strong>fade</strong> fade vertically (change the pixels opacity according to their y position)</p></li>
<li><p><strong>map</strong> use an alpha mask (a byte array) to describe the pixels opacity.</p></li>
</ul>
<p>The coordinates in the mask are relative to the Object. That is if the object moves the masks move with it.</p>
<p>For the details of the mask <em>init</em> function see the <a class="reference external" href="#api">API</a> documentation below.</p>
</div>
<div class="section" id="update-mask">
<h3>Update mask<a class="headerlink" href="#update-mask" title="Permalink to this headline">¶</a></h3>
<p>AN existing mask can be updated with <code class="docutils literal notranslate"><span class="pre">lv_objmask_update_mask(objmask,</span> <span class="pre">mask_p,</span> <span class="pre">new_param)</span></code>, where <code class="docutils literal notranslate"><span class="pre">mask_p</span></code> is return value of <code class="docutils literal notranslate"><span class="pre">lv_objmask_add_mask</span></code>.</p>
</div>
<div class="section" id="remove-mask">
<h3>Remove mask<a class="headerlink" href="#remove-mask" title="Permalink to this headline">¶</a></h3>
<p>A mask can be removed with <code class="docutils literal notranslate"><span class="pre">lv_objmask_remove_mask(objmask,</span> <span class="pre">mask_p)</span></code></p>
</div>
</div>
<div class="section" id="events">
<h2>Events<a class="headerlink" href="#events" title="Permalink to this headline">¶</a></h2>
<p>Only the <a class="reference external" href="../overview/event.html#generic-events">Generic events</a> are sent by the object type.</p>
<p>Learn more about <a class="reference internal" href="../overview/event.html"><span class="doc">Events</span></a>.</p>
</div>
<div class="section" id="keys">
<h2>Keys<a class="headerlink" href="#keys" title="Permalink to this headline">¶</a></h2>
<p>No <em>Keys</em> are processed by the object type.</p>
<p>Learn more about <a class="reference internal" href="../overview/indev.html"><span class="doc">Keys</span></a>.</p>
</div>
<div class="section" id="example">
<h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
<div class="section" id="c">
<h3>C<a class="headerlink" href="#c" title="Permalink to this headline">¶</a></h3>
<div class="section" id="several-object-masks">
<h4>Several object masks<a class="headerlink" href="#several-object-masks" title="Permalink to this headline">¶</a></h4>
<iframe class='lv-example' src='../_static/built_lv_examples/lv_ex_objmask_1/?w=320&h=240'></iframe><div class="toggle docutils container">
<div class="header docutils container">
<p>code</p>
</div>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#include</span> <span class="cpf">&quot;../../../lv_examples.h&quot;</span><span class="cp"></span>
<span class="cp">#if LV_USE_OBJMASK</span>

<span class="kt">void</span> <span class="nf">lv_ex_objmask_1</span><span class="p">(</span><span class="kt">void</span><span class="p">)</span>
<span class="p">{</span>

    <span class="cm">/*Set a very visible color for the screen to clearly see what happens*/</span>
    <span class="n">lv_obj_set_style_local_bg_color</span><span class="p">(</span><span class="n">lv_scr_act</span><span class="p">(),</span> <span class="n">LV_OBJ_PART_MAIN</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="n">lv_color_hex3</span><span class="p">(</span><span class="mh">0xf33</span><span class="p">));</span>

    <span class="n">lv_obj_t</span> <span class="o">*</span> <span class="n">om</span> <span class="o">=</span> <span class="n">lv_objmask_create</span><span class="p">(</span><span class="n">lv_scr_act</span><span class="p">(),</span> <span class="nb">NULL</span><span class="p">);</span>
    <span class="n">lv_obj_set_size</span><span class="p">(</span><span class="n">om</span><span class="p">,</span> <span class="mi">200</span><span class="p">,</span> <span class="mi">200</span><span class="p">);</span>
    <span class="n">lv_obj_align</span><span class="p">(</span><span class="n">om</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">,</span> <span class="n">LV_ALIGN_CENTER</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>
    <span class="n">lv_obj_t</span> <span class="o">*</span> <span class="n">label</span> <span class="o">=</span> <span class="n">lv_label_create</span><span class="p">(</span><span class="n">om</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">);</span>
    <span class="n">lv_label_set_long_mode</span><span class="p">(</span><span class="n">label</span><span class="p">,</span> <span class="n">LV_LABEL_LONG_BREAK</span><span class="p">);</span>
    <span class="n">lv_label_set_align</span><span class="p">(</span><span class="n">label</span><span class="p">,</span> <span class="n">LV_LABEL_ALIGN_CENTER</span><span class="p">);</span>
    <span class="n">lv_obj_set_width</span><span class="p">(</span><span class="n">label</span><span class="p">,</span> <span class="mi">180</span><span class="p">);</span>
    <span class="n">lv_label_set_text</span><span class="p">(</span><span class="n">label</span><span class="p">,</span> <span class="s">&quot;This label will be masked out. See how it works.&quot;</span><span class="p">);</span>
    <span class="n">lv_obj_align</span><span class="p">(</span><span class="n">label</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">,</span> <span class="n">LV_ALIGN_IN_TOP_MID</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">20</span><span class="p">);</span>

    <span class="n">lv_obj_t</span> <span class="o">*</span> <span class="n">cont</span> <span class="o">=</span> <span class="n">lv_cont_create</span><span class="p">(</span><span class="n">om</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">);</span>
    <span class="n">lv_obj_set_size</span><span class="p">(</span><span class="n">cont</span><span class="p">,</span> <span class="mi">180</span><span class="p">,</span> <span class="mi">100</span><span class="p">);</span>
    <span class="n">lv_obj_set_drag</span><span class="p">(</span><span class="n">cont</span><span class="p">,</span> <span class="nb">true</span><span class="p">);</span>
    <span class="n">lv_obj_align</span><span class="p">(</span><span class="n">cont</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">,</span> <span class="n">LV_ALIGN_IN_BOTTOM_MID</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">-10</span><span class="p">);</span>

    <span class="n">lv_obj_t</span> <span class="o">*</span> <span class="n">btn</span> <span class="o">=</span> <span class="n">lv_btn_create</span><span class="p">(</span><span class="n">cont</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">);</span>
    <span class="n">lv_obj_align</span><span class="p">(</span><span class="n">btn</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">,</span> <span class="n">LV_ALIGN_CENTER</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>
    <span class="n">lv_obj_set_style_local_value_str</span><span class="p">(</span><span class="n">btn</span><span class="p">,</span> <span class="n">LV_BTN_PART_MAIN</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="s">&quot;Button&quot;</span><span class="p">);</span>
    <span class="kt">uint32_t</span> <span class="n">t</span><span class="p">;</span>

    <span class="n">lv_refr_now</span><span class="p">(</span><span class="nb">NULL</span><span class="p">);</span>
    <span class="n">t</span> <span class="o">=</span> <span class="n">lv_tick_get</span><span class="p">();</span>
    <span class="k">while</span><span class="p">(</span><span class="n">lv_tick_elaps</span><span class="p">(</span><span class="n">t</span><span class="p">)</span> <span class="o">&lt;</span> <span class="mi">1000</span><span class="p">);</span>

    <span class="n">lv_area_t</span> <span class="n">a</span><span class="p">;</span>
    <span class="n">lv_draw_mask_radius_param_t</span> <span class="n">r1</span><span class="p">;</span>

    <span class="n">a</span><span class="p">.</span><span class="n">x1</span> <span class="o">=</span> <span class="mi">10</span><span class="p">;</span>
    <span class="n">a</span><span class="p">.</span><span class="n">y1</span> <span class="o">=</span> <span class="mi">10</span><span class="p">;</span>
    <span class="n">a</span><span class="p">.</span><span class="n">x2</span> <span class="o">=</span> <span class="mi">190</span><span class="p">;</span>
    <span class="n">a</span><span class="p">.</span><span class="n">y2</span> <span class="o">=</span> <span class="mi">190</span><span class="p">;</span>
    <span class="n">lv_draw_mask_radius_init</span><span class="p">(</span><span class="o">&amp;</span><span class="n">r1</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">a</span><span class="p">,</span> <span class="n">LV_RADIUS_CIRCLE</span><span class="p">,</span> <span class="nb">false</span><span class="p">);</span>
    <span class="n">lv_objmask_add_mask</span><span class="p">(</span><span class="n">om</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">r1</span><span class="p">);</span>

    <span class="n">lv_refr_now</span><span class="p">(</span><span class="nb">NULL</span><span class="p">);</span>
    <span class="n">t</span> <span class="o">=</span> <span class="n">lv_tick_get</span><span class="p">();</span>
    <span class="k">while</span><span class="p">(</span><span class="n">lv_tick_elaps</span><span class="p">(</span><span class="n">t</span><span class="p">)</span> <span class="o">&lt;</span> <span class="mi">1000</span><span class="p">);</span>

    <span class="n">a</span><span class="p">.</span><span class="n">x1</span> <span class="o">=</span> <span class="mi">100</span><span class="p">;</span>
    <span class="n">a</span><span class="p">.</span><span class="n">y1</span> <span class="o">=</span> <span class="mi">100</span><span class="p">;</span>
    <span class="n">a</span><span class="p">.</span><span class="n">x2</span> <span class="o">=</span> <span class="mi">150</span><span class="p">;</span>
    <span class="n">a</span><span class="p">.</span><span class="n">y2</span> <span class="o">=</span> <span class="mi">150</span><span class="p">;</span>
    <span class="n">lv_draw_mask_radius_init</span><span class="p">(</span><span class="o">&amp;</span><span class="n">r1</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">a</span><span class="p">,</span> <span class="n">LV_RADIUS_CIRCLE</span><span class="p">,</span> <span class="nb">true</span><span class="p">);</span>
    <span class="n">lv_objmask_add_mask</span><span class="p">(</span><span class="n">om</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">r1</span><span class="p">);</span>

    <span class="n">lv_refr_now</span><span class="p">(</span><span class="nb">NULL</span><span class="p">);</span>
    <span class="n">t</span> <span class="o">=</span> <span class="n">lv_tick_get</span><span class="p">();</span>
    <span class="k">while</span><span class="p">(</span><span class="n">lv_tick_elaps</span><span class="p">(</span><span class="n">t</span><span class="p">)</span> <span class="o">&lt;</span> <span class="mi">1000</span><span class="p">);</span>

    <span class="n">lv_draw_mask_line_param_t</span> <span class="n">l1</span><span class="p">;</span>
    <span class="n">lv_draw_mask_line_points_init</span><span class="p">(</span><span class="o">&amp;</span><span class="n">l1</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">100</span><span class="p">,</span> <span class="mi">200</span><span class="p">,</span> <span class="n">LV_DRAW_MASK_LINE_SIDE_TOP</span><span class="p">);</span>
    <span class="n">lv_objmask_add_mask</span><span class="p">(</span><span class="n">om</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">l1</span><span class="p">);</span>

    <span class="n">lv_refr_now</span><span class="p">(</span><span class="nb">NULL</span><span class="p">);</span>
    <span class="n">t</span> <span class="o">=</span> <span class="n">lv_tick_get</span><span class="p">();</span>
    <span class="k">while</span><span class="p">(</span><span class="n">lv_tick_elaps</span><span class="p">(</span><span class="n">t</span><span class="p">)</span> <span class="o">&lt;</span> <span class="mi">1000</span><span class="p">);</span>

    <span class="n">lv_draw_mask_fade_param_t</span> <span class="n">f1</span><span class="p">;</span>
    <span class="n">a</span><span class="p">.</span><span class="n">x1</span> <span class="o">=</span> <span class="mi">100</span><span class="p">;</span>
    <span class="n">a</span><span class="p">.</span><span class="n">y1</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
    <span class="n">a</span><span class="p">.</span><span class="n">x2</span> <span class="o">=</span> <span class="mi">200</span><span class="p">;</span>
    <span class="n">a</span><span class="p">.</span><span class="n">y2</span> <span class="o">=</span> <span class="mi">200</span><span class="p">;</span>
    <span class="n">lv_draw_mask_fade_init</span><span class="p">(</span><span class="o">&amp;</span><span class="n">f1</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">a</span><span class="p">,</span> <span class="n">LV_OPA_TRANSP</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">LV_OPA_COVER</span><span class="p">,</span> <span class="mi">150</span><span class="p">);</span>
    <span class="n">lv_objmask_add_mask</span><span class="p">(</span><span class="n">om</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">f1</span><span class="p">);</span>
<span class="p">}</span>

<span class="cp">#endif</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="text-mask">
<h4>Text mask<a class="headerlink" href="#text-mask" title="Permalink to this headline">¶</a></h4>
<iframe class='lv-example' src='../_static/built_lv_examples/lv_ex_objmask_2/?w=320&h=240'></iframe><div class="toggle docutils container">
<div class="header docutils container">
<p>code</p>
</div>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#include</span> <span class="cpf">&quot;../../../lv_examples.h&quot;</span><span class="cp"></span>
<span class="cp">#if LV_USE_OBJMASK</span>

<span class="cp">#define MASK_WIDTH 100</span>
<span class="cp">#define MASK_HEIGHT 50</span>

<span class="kt">void</span> <span class="nf">lv_ex_objmask_2</span><span class="p">(</span><span class="kt">void</span><span class="p">)</span>
<span class="p">{</span>

    <span class="cm">/* Create the mask of a text by drawing it to a canvas*/</span>
    <span class="k">static</span> <span class="n">lv_opa_t</span> <span class="n">mask_map</span><span class="p">[</span><span class="n">MASK_WIDTH</span> <span class="o">*</span> <span class="n">MASK_HEIGHT</span><span class="p">];</span>

    <span class="cm">/*Create a &quot;8 bit alpha&quot; canvas and clear it*/</span>
    <span class="n">lv_obj_t</span> <span class="o">*</span> <span class="n">canvas</span> <span class="o">=</span> <span class="n">lv_canvas_create</span><span class="p">(</span><span class="n">lv_scr_act</span><span class="p">(),</span> <span class="nb">NULL</span><span class="p">);</span>
    <span class="n">lv_canvas_set_buffer</span><span class="p">(</span><span class="n">canvas</span><span class="p">,</span> <span class="n">mask_map</span><span class="p">,</span> <span class="n">MASK_WIDTH</span><span class="p">,</span> <span class="n">MASK_HEIGHT</span><span class="p">,</span> <span class="n">LV_IMG_CF_ALPHA_8BIT</span><span class="p">);</span>
    <span class="n">lv_canvas_fill_bg</span><span class="p">(</span><span class="n">canvas</span><span class="p">,</span> <span class="n">LV_COLOR_BLACK</span><span class="p">,</span> <span class="n">LV_OPA_TRANSP</span><span class="p">);</span>

    <span class="cm">/*Draw a label to the canvas. The result &quot;image&quot; will be used as mask*/</span>
    <span class="n">lv_draw_label_dsc_t</span> <span class="n">label_dsc</span><span class="p">;</span>
    <span class="n">lv_draw_label_dsc_init</span><span class="p">(</span><span class="o">&amp;</span><span class="n">label_dsc</span><span class="p">);</span>
    <span class="n">label_dsc</span><span class="p">.</span><span class="n">color</span> <span class="o">=</span> <span class="n">LV_COLOR_WHITE</span><span class="p">;</span>
    <span class="n">lv_canvas_draw_text</span><span class="p">(</span><span class="n">canvas</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="n">MASK_WIDTH</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">label_dsc</span><span class="p">,</span> <span class="s">&quot;Text with gradient&quot;</span><span class="p">,</span> <span class="n">LV_LABEL_ALIGN_CENTER</span><span class="p">);</span>

    <span class="cm">/*The mask is reads the canvas is not required anymore*/</span>
    <span class="n">lv_obj_del</span><span class="p">(</span><span class="n">canvas</span><span class="p">);</span>

    <span class="cm">/*Create an object mask which will use the created mask*/</span>
    <span class="n">lv_obj_t</span> <span class="o">*</span> <span class="n">om</span> <span class="o">=</span> <span class="n">lv_objmask_create</span><span class="p">(</span><span class="n">lv_scr_act</span><span class="p">(),</span> <span class="nb">NULL</span><span class="p">);</span>
    <span class="n">lv_obj_set_size</span><span class="p">(</span><span class="n">om</span><span class="p">,</span> <span class="n">MASK_WIDTH</span><span class="p">,</span> <span class="n">MASK_HEIGHT</span><span class="p">);</span>
    <span class="n">lv_obj_align</span><span class="p">(</span><span class="n">om</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">,</span> <span class="n">LV_ALIGN_CENTER</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>

    <span class="cm">/*Add the created mask map to the object mask*/</span>
    <span class="n">lv_draw_mask_map_param_t</span> <span class="n">m</span><span class="p">;</span>
    <span class="n">lv_area_t</span> <span class="n">a</span><span class="p">;</span>
    <span class="n">a</span><span class="p">.</span><span class="n">x1</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
    <span class="n">a</span><span class="p">.</span><span class="n">y1</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
    <span class="n">a</span><span class="p">.</span><span class="n">x2</span> <span class="o">=</span> <span class="n">MASK_WIDTH</span> <span class="o">-</span> <span class="mi">1</span><span class="p">;</span>
    <span class="n">a</span><span class="p">.</span><span class="n">y2</span> <span class="o">=</span> <span class="n">MASK_HEIGHT</span> <span class="o">-</span> <span class="mi">1</span><span class="p">;</span>
    <span class="n">lv_draw_mask_map_init</span><span class="p">(</span><span class="o">&amp;</span><span class="n">m</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">a</span><span class="p">,</span> <span class="n">mask_map</span><span class="p">);</span>
    <span class="n">lv_objmask_add_mask</span><span class="p">(</span><span class="n">om</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">m</span><span class="p">);</span>

    <span class="cm">/*Create a style with gradient*/</span>
    <span class="k">static</span> <span class="n">lv_style_t</span> <span class="n">style_bg</span><span class="p">;</span>
    <span class="n">lv_style_init</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_bg</span><span class="p">);</span>
    <span class="n">lv_style_set_bg_opa</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_bg</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="n">LV_OPA_COVER</span><span class="p">);</span>
    <span class="n">lv_style_set_bg_color</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_bg</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="n">LV_COLOR_RED</span><span class="p">);</span>
    <span class="n">lv_style_set_bg_grad_color</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_bg</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="n">LV_COLOR_BLUE</span><span class="p">);</span>
    <span class="n">lv_style_set_bg_grad_dir</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_bg</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="n">LV_GRAD_DIR_HOR</span><span class="p">);</span>

    <span class="cm">/* Create and object with the gradient style on the object mask.</span>
<span class="cm">     * The text will be masked from the gradient*/</span>
    <span class="n">lv_obj_t</span> <span class="o">*</span> <span class="n">bg</span> <span class="o">=</span> <span class="n">lv_obj_create</span><span class="p">(</span><span class="n">om</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">);</span>
    <span class="n">lv_obj_reset_style_list</span><span class="p">(</span><span class="n">bg</span><span class="p">,</span> <span class="n">LV_OBJ_PART_MAIN</span><span class="p">);</span>
    <span class="n">lv_obj_add_style</span><span class="p">(</span><span class="n">bg</span><span class="p">,</span> <span class="n">LV_OBJ_PART_MAIN</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">style_bg</span><span class="p">);</span>
    <span class="n">lv_obj_set_size</span><span class="p">(</span><span class="n">bg</span><span class="p">,</span> <span class="n">MASK_WIDTH</span><span class="p">,</span> <span class="n">MASK_HEIGHT</span><span class="p">);</span>

<span class="p">}</span>

<span class="cp">#endif</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="section" id="micropython">
<h3>MicroPython<a class="headerlink" href="#micropython" title="Permalink to this headline">¶</a></h3>
<div class="section" id="id1">
<h4>Several object masks<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h4>
Click to try in the simulator!<br/><a target='_blank' href='https://sim.lvgl.io/v7/micropython/ports/javascript/bundle_out/index.html?script_startup=https://raw.githubusercontent.com/lvgl/lv_demos/release/v7/src/header.py&script=https://raw.githubusercontent.com/lvgl/lv_examples/9ebc61df6b7be07bd2fb4257fec49bf0dd178e2d/lv_ex_objmask_1/lv_ex_objmask_1.py'><img alt='lv_ex_objmask_1' src='https://raw.githubusercontent.com/lvgl/lv_examples/9ebc61df6b7be07bd2fb4257fec49bf0dd178e2d/lv_ex_objmask_1/lv_ex_objmask_1.png'/></a><div class="toggle docutils container">
<div class="header docutils container">
<p>code</p>
</div>
<div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="c1"># Set a very visible color for the screen to clearly see what happens</span>
<span class="n">lv</span><span class="o">.</span><span class="n">scr_act</span><span class="p">()</span><span class="o">.</span><span class="n">set_style_local_bg_color</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">obj</span><span class="o">.</span><span class="n">PART</span><span class="o">.</span><span class="n">MAIN</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">color_hex3</span><span class="p">(</span><span class="mh">0xf33</span><span class="p">))</span>

<span class="n">om</span> <span class="o">=</span> <span class="n">lv</span><span class="o">.</span><span class="n">objmask</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">scr_act</span><span class="p">(),</span> <span class="kc">None</span><span class="p">)</span>
<span class="n">om</span><span class="o">.</span><span class="n">set_size</span><span class="p">(</span><span class="mi">200</span><span class="p">,</span> <span class="mi">200</span><span class="p">)</span>
<span class="n">om</span><span class="o">.</span><span class="n">align</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">ALIGN</span><span class="o">.</span><span class="n">CENTER</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="n">label</span> <span class="o">=</span> <span class="n">lv</span><span class="o">.</span><span class="n">label</span><span class="p">(</span><span class="n">om</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="n">label</span><span class="o">.</span><span class="n">set_long_mode</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">label</span><span class="o">.</span><span class="n">LONG</span><span class="o">.</span><span class="n">BREAK</span><span class="p">)</span>
<span class="n">label</span><span class="o">.</span><span class="n">set_align</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">label</span><span class="o">.</span><span class="n">ALIGN</span><span class="o">.</span><span class="n">CENTER</span><span class="p">)</span>
<span class="n">label</span><span class="o">.</span><span class="n">set_width</span><span class="p">(</span><span class="mi">180</span><span class="p">)</span>
<span class="n">label</span><span class="o">.</span><span class="n">set_text</span><span class="p">(</span><span class="s2">&quot;This label will be masked out. See how it works.&quot;</span><span class="p">)</span>
<span class="n">label</span><span class="o">.</span><span class="n">align</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">ALIGN</span><span class="o">.</span><span class="n">IN_TOP_MID</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">20</span><span class="p">)</span>

<span class="n">cont</span> <span class="o">=</span> <span class="n">lv</span><span class="o">.</span><span class="n">cont</span><span class="p">(</span><span class="n">om</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="n">cont</span><span class="o">.</span><span class="n">set_size</span><span class="p">(</span><span class="mi">180</span><span class="p">,</span> <span class="mi">100</span><span class="p">)</span>
<span class="n">cont</span><span class="o">.</span><span class="n">set_drag</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
<span class="n">cont</span><span class="o">.</span><span class="n">align</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">ALIGN</span><span class="o">.</span><span class="n">IN_BOTTOM_MID</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="o">-</span><span class="mi">10</span><span class="p">)</span>

<span class="n">btn</span> <span class="o">=</span> <span class="n">lv</span><span class="o">.</span><span class="n">btn</span><span class="p">(</span><span class="n">cont</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="n">btn</span><span class="o">.</span><span class="n">align</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">ALIGN</span><span class="o">.</span><span class="n">CENTER</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="n">btn</span><span class="o">.</span><span class="n">set_style_local_value_str</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">btn</span><span class="o">.</span><span class="n">PART</span><span class="o">.</span><span class="n">MAIN</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="s2">&quot;Button&quot;</span><span class="p">)</span>

<span class="n">lv</span><span class="o">.</span><span class="n">refr_now</span><span class="p">(</span><span class="kc">None</span><span class="p">);</span>
<span class="n">t</span> <span class="o">=</span> <span class="n">lv</span><span class="o">.</span><span class="n">tick_get</span><span class="p">();</span>
<span class="k">while</span> <span class="n">lv</span><span class="o">.</span><span class="n">tick_elaps</span><span class="p">(</span><span class="n">t</span><span class="p">)</span> <span class="o">&lt;</span> <span class="mi">1000</span><span class="p">:</span>
    <span class="k">pass</span>

<span class="n">a</span><span class="o">=</span><span class="n">lv</span><span class="o">.</span><span class="n">area_t</span><span class="p">()</span>
<span class="n">r1</span><span class="o">=</span><span class="n">lv</span><span class="o">.</span><span class="n">draw_mask_radius_param_t</span><span class="p">()</span>

<span class="n">a</span><span class="o">.</span><span class="n">x1</span> <span class="o">=</span> <span class="mi">10</span>
<span class="n">a</span><span class="o">.</span><span class="n">y1</span> <span class="o">=</span> <span class="mi">10</span>
<span class="n">a</span><span class="o">.</span><span class="n">x2</span> <span class="o">=</span> <span class="mi">190</span>
<span class="n">a</span><span class="o">.</span><span class="n">y2</span> <span class="o">=</span> <span class="mi">190</span>
<span class="n">r1</span><span class="o">.</span><span class="n">init</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">RADIUS</span><span class="o">.</span><span class="n">CIRCLE</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
<span class="n">om</span><span class="o">.</span><span class="n">add_mask</span><span class="p">(</span><span class="n">r1</span><span class="p">)</span>

<span class="n">lv</span><span class="o">.</span><span class="n">refr_now</span><span class="p">(</span><span class="kc">None</span><span class="p">);</span>
<span class="n">t</span> <span class="o">=</span> <span class="n">lv</span><span class="o">.</span><span class="n">tick_get</span><span class="p">();</span>
<span class="k">while</span> <span class="n">lv</span><span class="o">.</span><span class="n">tick_elaps</span><span class="p">(</span><span class="n">t</span><span class="p">)</span> <span class="o">&lt;</span> <span class="mi">1000</span><span class="p">:</span>
    <span class="k">pass</span>

<span class="n">a</span><span class="o">.</span><span class="n">x1</span> <span class="o">=</span> <span class="mi">100</span>
<span class="n">a</span><span class="o">.</span><span class="n">y1</span> <span class="o">=</span> <span class="mi">100</span>
<span class="n">a</span><span class="o">.</span><span class="n">x2</span> <span class="o">=</span> <span class="mi">150</span>
<span class="n">a</span><span class="o">.</span><span class="n">y2</span> <span class="o">=</span> <span class="mi">150</span>
<span class="n">r1</span><span class="o">.</span><span class="n">init</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">RADIUS</span><span class="o">.</span><span class="n">CIRCLE</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span>
<span class="n">om</span><span class="o">.</span><span class="n">add_mask</span><span class="p">(</span><span class="n">r1</span><span class="p">)</span>

<span class="n">lv</span><span class="o">.</span><span class="n">refr_now</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span>
<span class="n">t</span> <span class="o">=</span> <span class="n">lv</span><span class="o">.</span><span class="n">tick_get</span><span class="p">()</span>
<span class="k">while</span> <span class="n">lv</span><span class="o">.</span><span class="n">tick_elaps</span><span class="p">(</span><span class="n">t</span><span class="p">)</span> <span class="o">&lt;</span> <span class="mi">1000</span><span class="p">:</span>
    <span class="k">pass</span>

<span class="n">l1</span><span class="o">=</span><span class="n">lv</span><span class="o">.</span><span class="n">draw_mask_line_param_t</span><span class="p">()</span>
<span class="n">l1</span><span class="o">.</span><span class="n">points_init</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">100</span><span class="p">,</span> <span class="mi">200</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">DRAW_MASK_LINE_SIDE</span><span class="o">.</span><span class="n">TOP</span><span class="p">)</span>
<span class="n">om</span><span class="o">.</span><span class="n">add_mask</span><span class="p">(</span><span class="n">l1</span><span class="p">)</span>

<span class="n">lv</span><span class="o">.</span><span class="n">refr_now</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span>
<span class="n">t</span> <span class="o">=</span> <span class="n">lv</span><span class="o">.</span><span class="n">tick_get</span><span class="p">()</span>
<span class="k">while</span> <span class="n">lv</span><span class="o">.</span><span class="n">tick_elaps</span><span class="p">(</span><span class="n">t</span><span class="p">)</span> <span class="o">&lt;</span> <span class="mi">1000</span><span class="p">:</span>
    <span class="k">pass</span>

<span class="n">f1</span><span class="o">=</span> <span class="n">lv</span><span class="o">.</span><span class="n">draw_mask_fade_param_t</span><span class="p">()</span>
<span class="n">a</span><span class="o">.</span><span class="n">x1</span> <span class="o">=</span> <span class="mi">100</span>
<span class="n">a</span><span class="o">.</span><span class="n">y1</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">a</span><span class="o">.</span><span class="n">x2</span> <span class="o">=</span> <span class="mi">200</span>
<span class="n">a</span><span class="o">.</span><span class="n">y2</span> <span class="o">=</span> <span class="mi">200</span>
<span class="n">f1</span><span class="o">.</span><span class="n">init</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">OPA</span><span class="o">.</span><span class="n">TRANSP</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">OPA</span><span class="o">.</span><span class="n">COVER</span><span class="p">,</span> <span class="mi">150</span><span class="p">)</span>
<span class="n">om</span><span class="o">.</span><span class="n">add_mask</span><span class="p">(</span><span class="n">f1</span><span class="p">)</span>

</pre></div>
</div>
</div>
</div>
<div class="section" id="id2">
<h4>Text mask<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h4>
Click to try in the simulator!<br/><a target='_blank' href='https://sim.lvgl.io/v7/micropython/ports/javascript/bundle_out/index.html?script_startup=https://raw.githubusercontent.com/lvgl/lv_demos/release/v7/src/header.py&script=https://raw.githubusercontent.com/lvgl/lv_examples/9ebc61df6b7be07bd2fb4257fec49bf0dd178e2d/lv_ex_objmask_2/lv_ex_objmask_2.py'><img alt='lv_ex_objmask_2' src='https://raw.githubusercontent.com/lvgl/lv_examples/9ebc61df6b7be07bd2fb4257fec49bf0dd178e2d/lv_ex_objmask_2/lv_ex_objmask_2.png'/></a><div class="toggle docutils container">
<div class="header docutils container">
<p>code</p>
</div>
<div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">lv_colors</span> <span class="kn">import</span> <span class="n">lv_colors</span>

<span class="n">MASK_WIDTH</span><span class="o">=</span><span class="mi">100</span>
<span class="n">MASK_HEIGHT</span><span class="o">=</span><span class="mi">50</span>

<span class="c1"># Create the mask of a text by drawing it to a canvas</span>
<span class="n">mask_map</span> <span class="o">=</span> <span class="nb">bytearray</span> <span class="p">(</span><span class="n">MASK_WIDTH</span> <span class="o">*</span> <span class="n">MASK_HEIGHT</span> <span class="o">*</span><span class="mi">4</span><span class="p">)</span>

<span class="c1"># Create a &quot;8 bit alpha&quot; canvas and clear it</span>
<span class="n">canvas</span> <span class="o">=</span> <span class="n">lv</span><span class="o">.</span><span class="n">canvas</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">scr_act</span><span class="p">(),</span> <span class="kc">None</span><span class="p">)</span>
<span class="n">canvas</span><span class="o">.</span><span class="n">set_buffer</span><span class="p">(</span><span class="n">mask_map</span><span class="p">,</span> <span class="n">MASK_WIDTH</span><span class="p">,</span> <span class="n">MASK_HEIGHT</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">img</span><span class="o">.</span><span class="n">CF</span><span class="o">.</span><span class="n">ALPHA_8BIT</span><span class="p">)</span>
<span class="n">canvas</span><span class="o">.</span><span class="n">fill_bg</span><span class="p">(</span><span class="n">lv_colors</span><span class="o">.</span><span class="n">BLACK</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">OPA</span><span class="o">.</span><span class="n">TRANSP</span><span class="p">)</span>

<span class="c1"># Draw a label to the canvas. The result &quot;image&quot; will be used as mask</span>
<span class="n">label_dsc</span> <span class="o">=</span> <span class="n">lv</span><span class="o">.</span><span class="n">draw_label_dsc_t</span><span class="p">()</span>
<span class="n">label_dsc</span><span class="o">.</span><span class="n">init</span><span class="p">()</span>
<span class="n">label_dsc</span><span class="o">.</span><span class="n">color</span> <span class="o">=</span> <span class="n">lv_colors</span><span class="o">.</span><span class="n">WHITE</span>
<span class="n">canvas</span><span class="o">.</span><span class="n">draw_text</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="n">MASK_WIDTH</span><span class="p">,</span> <span class="n">label_dsc</span><span class="p">,</span> <span class="s2">&quot;Text with gradient&quot;</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">label</span><span class="o">.</span><span class="n">ALIGN</span><span class="o">.</span><span class="n">CENTER</span><span class="p">)</span>

<span class="c1"># The mask is read, the canvas is not required anymore</span>
<span class="n">canvas</span><span class="o">.</span><span class="n">delete</span><span class="p">()</span>

<span class="c1"># Create an object mask which will use the created mask</span>
<span class="n">om</span> <span class="o">=</span> <span class="n">lv</span><span class="o">.</span><span class="n">objmask</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">scr_act</span><span class="p">(),</span> <span class="kc">None</span><span class="p">)</span>
<span class="n">om</span><span class="o">.</span><span class="n">set_size</span><span class="p">(</span><span class="n">MASK_WIDTH</span><span class="p">,</span> <span class="n">MASK_HEIGHT</span><span class="p">)</span>
<span class="n">om</span><span class="o">.</span><span class="n">align</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">ALIGN</span><span class="o">.</span><span class="n">CENTER</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>

<span class="c1"># Add the created mask map to the object mask</span>
<span class="n">m</span> <span class="o">=</span> <span class="n">lv</span><span class="o">.</span><span class="n">draw_mask_map_param_t</span><span class="p">()</span>
<span class="n">a</span><span class="o">=</span><span class="n">lv</span><span class="o">.</span><span class="n">area_t</span><span class="p">()</span>
<span class="n">a</span><span class="o">.</span><span class="n">x1</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">a</span><span class="o">.</span><span class="n">y1</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">a</span><span class="o">.</span><span class="n">x2</span> <span class="o">=</span> <span class="n">MASK_WIDTH</span> <span class="o">-</span> <span class="mi">1</span>
<span class="n">a</span><span class="o">.</span><span class="n">y2</span> <span class="o">=</span> <span class="n">MASK_HEIGHT</span> <span class="o">-</span> <span class="mi">1</span>

<span class="n">m</span><span class="o">.</span><span class="n">init</span><span class="p">(</span><span class="n">a</span><span class="p">,</span><span class="n">mask_map</span><span class="p">)</span>
<span class="n">om</span><span class="o">.</span><span class="n">add_mask</span><span class="p">(</span><span class="n">m</span><span class="p">)</span>

<span class="c1"># Create a style with gradient</span>
<span class="n">style_bg</span><span class="o">=</span> <span class="n">lv</span><span class="o">.</span><span class="n">style_t</span><span class="p">()</span>
<span class="n">style_bg</span><span class="o">.</span><span class="n">init</span><span class="p">()</span>
<span class="n">style_bg</span><span class="o">.</span><span class="n">set_bg_opa</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">OPA</span><span class="o">.</span><span class="n">COVER</span><span class="p">)</span>
<span class="n">style_bg</span><span class="o">.</span><span class="n">set_bg_color</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="n">lv_colors</span><span class="o">.</span><span class="n">RED</span><span class="p">)</span>
<span class="n">style_bg</span><span class="o">.</span><span class="n">set_bg_grad_color</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="n">lv_colors</span><span class="o">.</span><span class="n">BLUE</span><span class="p">)</span>
<span class="n">style_bg</span><span class="o">.</span><span class="n">set_bg_grad_dir</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">GRAD_DIR</span><span class="o">.</span><span class="n">HOR</span><span class="p">)</span>

<span class="c1"># Create and object with the gradient style on the object mask.</span>
<span class="c1"># The text will be masked from the gradient</span>
<span class="n">bg</span> <span class="o">=</span> <span class="n">lv</span><span class="o">.</span><span class="n">obj</span><span class="p">(</span><span class="n">om</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="n">bg</span><span class="o">.</span><span class="n">reset_style_list</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">obj</span><span class="o">.</span><span class="n">PART</span><span class="o">.</span><span class="n">MAIN</span><span class="p">)</span>
<span class="n">bg</span><span class="o">.</span><span class="n">add_style</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">obj</span><span class="o">.</span><span class="n">PART</span><span class="o">.</span><span class="n">MAIN</span><span class="p">,</span> <span class="n">style_bg</span><span class="p">)</span>
<span class="n">bg</span><span class="o">.</span><span class="n">set_size</span><span class="p">(</span><span class="n">MASK_WIDTH</span><span class="p">,</span> <span class="n">MASK_HEIGHT</span><span class="p">)</span>

</pre></div>
</div>
</div>
</div>
</div>
</div>
<div class="section" id="api">
<h2>API<a class="headerlink" href="#api" title="Permalink to this headline">¶</a></h2>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-typedefs">Typedefs</p>
<dl class="cpp type">
<dt id="_CPPv417lv_objmask_part_t">
<span id="_CPPv317lv_objmask_part_t"></span><span id="_CPPv217lv_objmask_part_t"></span><span id="lv_objmask_part_t"></span><span class="target" id="lv__objmask_8h_1a430551080ad7a4aaeb5831d8ce0696b3"></span><em class="property"><span class="pre">typedef</span> </em><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">lv_objmask_part_t</span></code><a class="headerlink" href="#_CPPv417lv_objmask_part_t" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-enums">Enums</p>
<dl class="cpp enum">
<dt id="_CPPv4Ut2_92">
<span id="_CPPv3Ut2_92"></span><span class="target" id="lv__objmask_8h_1a7495a48740c9d555f7fbcb48246dbd93"></span><em class="property"><span class="pre">enum</span> </em><strong><span class="pre">[anonymous]</span></strong><a class="headerlink" href="#_CPPv4Ut2_92" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><em>Values:</em></p>
<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_9220LV_OBJMASK_PART_MAINE">
<span id="_CPPv3NUt2_9220LV_OBJMASK_PART_MAINE"></span><span class="target" id="lv__objmask_8h_1a7495a48740c9d555f7fbcb48246dbd93ad82ee9bcde8efc2349eca5a12e5f019e"></span><em class="property"><span class="pre">enumerator</span> </em><code class="sig-name descname"><span class="pre">LV_OBJMASK_PART_MAIN</span></code><a class="headerlink" href="#_CPPv4NUt2_9220LV_OBJMASK_PART_MAINE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

</dd></dl>

</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-functions">Functions</p>
<dl class="cpp function">
<dt id="_CPPv417lv_objmask_createP8lv_obj_tPK8lv_obj_t">
<span id="_CPPv317lv_objmask_createP8lv_obj_tPK8lv_obj_t"></span><span id="_CPPv217lv_objmask_createP8lv_obj_tPK8lv_obj_t"></span><span id="lv_objmask_create__lv_obj_tP.lv_obj_tCP"></span><span class="target" id="lv__objmask_8h_1a75ccba24c02bab378389f3cbba6bae96"></span><a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t"><span class="pre">lv_obj_t</span></a> <span class="pre">*</span><code class="sig-name descname"><span class="pre">lv_objmask_create</span></code><span class="sig-paren">(</span><a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t"><span class="pre">lv_obj_t</span></a> <span class="pre">*</span><em><span class="pre">par</span></em>, <em class="property"><span class="pre">const</span></em> <a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t"><span class="pre">lv_obj_t</span></a> <span class="pre">*</span><em><span class="pre">copy</span></em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv417lv_objmask_createP8lv_obj_tPK8lv_obj_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Create a object mask objects </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>par</strong> -- pointer to an object, it will be the parent of the new object mask </p></li>
<li><p><strong>copy</strong> -- pointer to a object mask object, if not NULL then the new object will be copied from it </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>pointer to the created object mask </p>
</dd>
</dl>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv419lv_objmask_add_maskP8lv_obj_tPv">
<span id="_CPPv319lv_objmask_add_maskP8lv_obj_tPv"></span><span id="_CPPv219lv_objmask_add_maskP8lv_obj_tPv"></span><span id="lv_objmask_add_mask__lv_obj_tP.voidP"></span><span class="target" id="lv__objmask_8h_1af2bc61d19261ed07dc2ad9dbad4e5385"></span><a class="reference internal" href="#_CPPv417lv_objmask_mask_t" title="lv_objmask_mask_t"><span class="pre">lv_objmask_mask_t</span></a> <span class="pre">*</span><code class="sig-name descname"><span class="pre">lv_objmask_add_mask</span></code><span class="sig-paren">(</span><a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t"><span class="pre">lv_obj_t</span></a> <span class="pre">*</span><em><span class="pre">objmask</span></em>, <span class="pre">void</span> <span class="pre">*</span><em><span class="pre">param</span></em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv419lv_objmask_add_maskP8lv_obj_tPv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Add a mask </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>objmask</strong> -- pointer to an Object mask object </p></li>
<li><p><strong>param</strong> -- an initialized mask parameter </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>pointer to the added mask </p>
</dd>
</dl>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv422lv_objmask_update_maskP8lv_obj_tP17lv_objmask_mask_tPv">
<span id="_CPPv322lv_objmask_update_maskP8lv_obj_tP17lv_objmask_mask_tPv"></span><span id="_CPPv222lv_objmask_update_maskP8lv_obj_tP17lv_objmask_mask_tPv"></span><span id="lv_objmask_update_mask__lv_obj_tP.lv_objmask_mask_tP.voidP"></span><span class="target" id="lv__objmask_8h_1ad0c33dde35f0fd3b513f182d1d477309"></span><span class="pre">void</span> <code class="sig-name descname"><span class="pre">lv_objmask_update_mask</span></code><span class="sig-paren">(</span><a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t"><span class="pre">lv_obj_t</span></a> <span class="pre">*</span><em><span class="pre">objmask</span></em>, <a class="reference internal" href="#_CPPv417lv_objmask_mask_t" title="lv_objmask_mask_t"><span class="pre">lv_objmask_mask_t</span></a> <span class="pre">*</span><em><span class="pre">mask</span></em>, <span class="pre">void</span> <span class="pre">*</span><em><span class="pre">param</span></em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv422lv_objmask_update_maskP8lv_obj_tP17lv_objmask_mask_tPv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Update an already created mask </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>objmask</strong> -- pointer to an Object mask object </p></li>
<li><p><strong>mask</strong> -- pointer to created mask (returned by <code class="docutils literal notranslate"><span class="pre">lv_objmask_add_mask</span></code>) </p></li>
<li><p><strong>param</strong> -- an initialized mask parameter (initialized by <code class="docutils literal notranslate"><span class="pre">lv_draw_mask_line/angle/.../_init</span></code>) </p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv422lv_objmask_remove_maskP8lv_obj_tP17lv_objmask_mask_t">
<span id="_CPPv322lv_objmask_remove_maskP8lv_obj_tP17lv_objmask_mask_t"></span><span id="_CPPv222lv_objmask_remove_maskP8lv_obj_tP17lv_objmask_mask_t"></span><span id="lv_objmask_remove_mask__lv_obj_tP.lv_objmask_mask_tP"></span><span class="target" id="lv__objmask_8h_1aad197450e8678f0edc7f39a744124160"></span><span class="pre">void</span> <code class="sig-name descname"><span class="pre">lv_objmask_remove_mask</span></code><span class="sig-paren">(</span><a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t"><span class="pre">lv_obj_t</span></a> <span class="pre">*</span><em><span class="pre">objmask</span></em>, <a class="reference internal" href="#_CPPv417lv_objmask_mask_t" title="lv_objmask_mask_t"><span class="pre">lv_objmask_mask_t</span></a> <span class="pre">*</span><em><span class="pre">mask</span></em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv422lv_objmask_remove_maskP8lv_obj_tP17lv_objmask_mask_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Remove a mask </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>objmask</strong> -- pointer to an Object mask object </p></li>
<li><p><strong>mask</strong> -- pointer to created mask (returned by <code class="docutils literal notranslate"><span class="pre">lv_objmask_add_mask</span></code>) If <code class="docutils literal notranslate"><span class="pre">NULL</span></code> passed all masks will be deleted. </p></li>
</ul>
</dd>
</dl>
</dd></dl>

</div>
<dl class="cpp struct">
<dt id="_CPPv417lv_objmask_mask_t">
<span id="_CPPv317lv_objmask_mask_t"></span><span id="_CPPv217lv_objmask_mask_t"></span><span id="lv_objmask_mask_t"></span><span class="target" id="structlv__objmask__mask__t"></span><em class="property"><span class="pre">struct</span> </em><code class="sig-name descname"><span class="pre">lv_objmask_mask_t</span></code><a class="headerlink" href="#_CPPv417lv_objmask_mask_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p>
<dl class="cpp var">
<dt id="_CPPv4N17lv_objmask_mask_t5paramE">
<span id="_CPPv3N17lv_objmask_mask_t5paramE"></span><span id="_CPPv2N17lv_objmask_mask_t5paramE"></span><span id="lv_objmask_mask_t::param__voidP"></span><span class="target" id="structlv__objmask__mask__t_1a82a3be681ad5dc1a8e680ab98d91ee93"></span><span class="pre">void</span> <span class="pre">*</span><code class="sig-name descname"><span class="pre">param</span></code><a class="headerlink" href="#_CPPv4N17lv_objmask_mask_t5paramE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

</div>
</dd></dl>

<dl class="cpp struct">
<dt id="_CPPv416lv_objmask_ext_t">
<span id="_CPPv316lv_objmask_ext_t"></span><span id="_CPPv216lv_objmask_ext_t"></span><span id="lv_objmask_ext_t"></span><span class="target" id="structlv__objmask__ext__t"></span><em class="property"><span class="pre">struct</span> </em><code class="sig-name descname"><span class="pre">lv_objmask_ext_t</span></code><a class="headerlink" href="#_CPPv416lv_objmask_ext_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p>
<dl class="cpp var">
<dt id="_CPPv4N16lv_objmask_ext_t4contE">
<span id="_CPPv3N16lv_objmask_ext_t4contE"></span><span id="_CPPv2N16lv_objmask_ext_t4contE"></span><span id="lv_objmask_ext_t::cont__lv_cont_ext_t"></span><span class="target" id="structlv__objmask__ext__t_1a856b9f9e26bbb8c06d2ca866017c3fef"></span><a class="reference internal" href="cont.html#_CPPv413lv_cont_ext_t" title="lv_cont_ext_t"><span class="pre">lv_cont_ext_t</span></a> <code class="sig-name descname"><span class="pre">cont</span></code><a class="headerlink" href="#_CPPv4N16lv_objmask_ext_t4contE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N16lv_objmask_ext_t7mask_llE">
<span id="_CPPv3N16lv_objmask_ext_t7mask_llE"></span><span id="_CPPv2N16lv_objmask_ext_t7mask_llE"></span><span id="lv_objmask_ext_t::mask_ll__lv_ll_t"></span><span class="target" id="structlv__objmask__ext__t_1a61d19203026003e76e46e57a5adc0739"></span><span class="pre">lv_ll_t</span> <code class="sig-name descname"><span class="pre">mask_ll</span></code><a class="headerlink" href="#_CPPv4N16lv_objmask_ext_t7mask_llE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

</div>
</dd></dl>

<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-typedefs">Typedefs</p>
<dl class="cpp type">
<dt id="_CPPv418lv_draw_mask_res_t">
<span id="_CPPv318lv_draw_mask_res_t"></span><span id="_CPPv218lv_draw_mask_res_t"></span><span id="lv_draw_mask_res_t"></span><span class="target" id="lv__draw__mask_8h_1aee52f75d7d96363ddb868b6f17784170"></span><em class="property"><span class="pre">typedef</span> </em><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">lv_draw_mask_res_t</span></code><a class="headerlink" href="#_CPPv418lv_draw_mask_res_t" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp type">
<dt id="_CPPv419lv_draw_mask_type_t">
<span id="_CPPv319lv_draw_mask_type_t"></span><span id="_CPPv219lv_draw_mask_type_t"></span><span id="lv_draw_mask_type_t"></span><span class="target" id="lv__draw__mask_8h_1adb77f92dd00ae07c73ed2d47eeab2069"></span><em class="property"><span class="pre">typedef</span> </em><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">lv_draw_mask_type_t</span></code><a class="headerlink" href="#_CPPv419lv_draw_mask_type_t" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp type">
<dt id="_CPPv418lv_draw_mask_xcb_t">
<span id="_CPPv318lv_draw_mask_xcb_t"></span><span id="_CPPv218lv_draw_mask_xcb_t"></span><span id="lv_draw_mask_xcb_t"></span><span class="target" id="lv__draw__mask_8h_1afd0685a4a8f4ddbd982434d8dc318624"></span><em class="property"><span class="pre">typedef</span> </em><a class="reference internal" href="#_CPPv418lv_draw_mask_res_t" title="lv_draw_mask_res_t"><span class="pre">lv_draw_mask_res_t</span></a> <span class="pre">(</span><span class="pre">*</span><code class="sig-name descname"><span class="pre">lv_draw_mask_xcb_t</span></code><span class="pre">)</span><span class="sig-paren">(</span><span class="pre">lv_opa_t</span> <span class="pre">*</span><span class="pre">mask_buf</span>, <span class="pre">lv_coord_t</span> <span class="pre">abs_x</span>, <span class="pre">lv_coord_t</span> <span class="pre">abs_y</span>, <span class="pre">lv_coord_t</span> <span class="pre">len</span>, <span class="pre">void</span> <span class="pre">*</span><span class="pre">p</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv418lv_draw_mask_xcb_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>A common callback type for every mask type. Used internally by the library. </p>
</dd></dl>

<dl class="cpp type">
<dt id="_CPPv424lv_draw_mask_line_side_t">
<span id="_CPPv324lv_draw_mask_line_side_t"></span><span id="_CPPv224lv_draw_mask_line_side_t"></span><span id="lv_draw_mask_line_side_t"></span><span class="target" id="lv__draw__mask_8h_1aa29c78941c1716e88ddcad299e66988f"></span><em class="property"><span class="pre">typedef</span> </em><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">lv_draw_mask_line_side_t</span></code><a class="headerlink" href="#_CPPv424lv_draw_mask_line_side_t" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp type">
<dt id="_CPPv424lv_draw_mask_map_param_t">
<span id="_CPPv324lv_draw_mask_map_param_t"></span><span id="_CPPv224lv_draw_mask_map_param_t"></span><span id="lv_draw_mask_map_param_t"></span><span class="target" id="lv__draw__mask_8h_1ab887f51520c46d8352949f16b5120bc3"></span><em class="property"><span class="pre">typedef</span> </em><em class="property"><span class="pre">struct</span></em> <a class="reference internal" href="#_CPPv425_lv_draw_mask_map_param_t" title="_lv_draw_mask_map_param_t"><span class="pre">_lv_draw_mask_map_param_t</span></a> <code class="sig-name descname"><span class="pre">lv_draw_mask_map_param_t</span></code><a class="headerlink" href="#_CPPv424lv_draw_mask_map_param_t" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp type">
<dt id="_CPPv425_lv_draw_mask_saved_arr_t">
<span id="_CPPv325_lv_draw_mask_saved_arr_t"></span><span id="_CPPv225_lv_draw_mask_saved_arr_t"></span><span id="_lv_draw_mask_saved_arr_t"></span><span class="target" id="lv__draw__mask_8h_1afc44c700846c50a57964367a88ff0323"></span><em class="property"><span class="pre">typedef</span> </em><a class="reference internal" href="#_CPPv421_lv_draw_mask_saved_t" title="_lv_draw_mask_saved_t"><span class="pre">_lv_draw_mask_saved_t</span></a> <code class="sig-name descname"><span class="pre">_lv_draw_mask_saved_arr_t</span></code><span class="pre">[</span><code class="sig-name descname"><span class="pre">_LV_MASK_MAX_NUM</span></code><span class="pre">]</span><a class="headerlink" href="#_CPPv425_lv_draw_mask_saved_arr_t" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-enums">Enums</p>
<dl class="cpp enum">
<dt id="_CPPv4Ut2_14">
<span id="_CPPv3Ut2_14"></span><span class="target" id="lv__draw__mask_8h_1a16af7b253440dadd46a80a4b9fddba4d"></span><em class="property"><span class="pre">enum</span> </em><strong><span class="pre">[anonymous]</span></strong><a class="headerlink" href="#_CPPv4Ut2_14" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><em>Values:</em></p>
<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_1423LV_DRAW_MASK_RES_TRANSPE">
<span id="_CPPv3NUt2_1423LV_DRAW_MASK_RES_TRANSPE"></span><span class="target" id="lv__draw__mask_8h_1a16af7b253440dadd46a80a4b9fddba4da174ee60d0bec0b67e0eb36eaeeb9ab83"></span><em class="property"><span class="pre">enumerator</span> </em><code class="sig-name descname"><span class="pre">LV_DRAW_MASK_RES_TRANSP</span></code><a class="headerlink" href="#_CPPv4NUt2_1423LV_DRAW_MASK_RES_TRANSPE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_1427LV_DRAW_MASK_RES_FULL_COVERE">
<span id="_CPPv3NUt2_1427LV_DRAW_MASK_RES_FULL_COVERE"></span><span class="target" id="lv__draw__mask_8h_1a16af7b253440dadd46a80a4b9fddba4daec08366ff4b1fcd94c311c1215db8d6d"></span><em class="property"><span class="pre">enumerator</span> </em><code class="sig-name descname"><span class="pre">LV_DRAW_MASK_RES_FULL_COVER</span></code><a class="headerlink" href="#_CPPv4NUt2_1427LV_DRAW_MASK_RES_FULL_COVERE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_1424LV_DRAW_MASK_RES_CHANGEDE">
<span id="_CPPv3NUt2_1424LV_DRAW_MASK_RES_CHANGEDE"></span><span class="target" id="lv__draw__mask_8h_1a16af7b253440dadd46a80a4b9fddba4daece1c493923ed02d30e7dc29c0f7a80e"></span><em class="property"><span class="pre">enumerator</span> </em><code class="sig-name descname"><span class="pre">LV_DRAW_MASK_RES_CHANGED</span></code><a class="headerlink" href="#_CPPv4NUt2_1424LV_DRAW_MASK_RES_CHANGEDE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_1424LV_DRAW_MASK_RES_UNKNOWNE">
<span id="_CPPv3NUt2_1424LV_DRAW_MASK_RES_UNKNOWNE"></span><span class="target" id="lv__draw__mask_8h_1a16af7b253440dadd46a80a4b9fddba4dac4dd8b48efd5a8042003b676cc728f30"></span><em class="property"><span class="pre">enumerator</span> </em><code class="sig-name descname"><span class="pre">LV_DRAW_MASK_RES_UNKNOWN</span></code><a class="headerlink" href="#_CPPv4NUt2_1424LV_DRAW_MASK_RES_UNKNOWNE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

</dd></dl>

<dl class="cpp enum">
<dt id="_CPPv4Ut2_15">
<span id="_CPPv3Ut2_15"></span><span class="target" id="lv__draw__mask_8h_1aba01db17f4a2bfbc3db60dc172972a25"></span><em class="property"><span class="pre">enum</span> </em><strong><span class="pre">[anonymous]</span></strong><a class="headerlink" href="#_CPPv4Ut2_15" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><em>Values:</em></p>
<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_1522LV_DRAW_MASK_TYPE_LINEE">
<span id="_CPPv3NUt2_1522LV_DRAW_MASK_TYPE_LINEE"></span><span class="target" id="lv__draw__mask_8h_1aba01db17f4a2bfbc3db60dc172972a25ae6d3ec8c33b186cb9d1f3c517bcc7be6"></span><em class="property"><span class="pre">enumerator</span> </em><code class="sig-name descname"><span class="pre">LV_DRAW_MASK_TYPE_LINE</span></code><a class="headerlink" href="#_CPPv4NUt2_1522LV_DRAW_MASK_TYPE_LINEE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_1523LV_DRAW_MASK_TYPE_ANGLEE">
<span id="_CPPv3NUt2_1523LV_DRAW_MASK_TYPE_ANGLEE"></span><span class="target" id="lv__draw__mask_8h_1aba01db17f4a2bfbc3db60dc172972a25a83d9703bb8d87de3a28e9436efab17b0"></span><em class="property"><span class="pre">enumerator</span> </em><code class="sig-name descname"><span class="pre">LV_DRAW_MASK_TYPE_ANGLE</span></code><a class="headerlink" href="#_CPPv4NUt2_1523LV_DRAW_MASK_TYPE_ANGLEE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_1524LV_DRAW_MASK_TYPE_RADIUSE">
<span id="_CPPv3NUt2_1524LV_DRAW_MASK_TYPE_RADIUSE"></span><span class="target" id="lv__draw__mask_8h_1aba01db17f4a2bfbc3db60dc172972a25a1b847faf79dc86181638f7c6dc34d5e6"></span><em class="property"><span class="pre">enumerator</span> </em><code class="sig-name descname"><span class="pre">LV_DRAW_MASK_TYPE_RADIUS</span></code><a class="headerlink" href="#_CPPv4NUt2_1524LV_DRAW_MASK_TYPE_RADIUSE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_1522LV_DRAW_MASK_TYPE_FADEE">
<span id="_CPPv3NUt2_1522LV_DRAW_MASK_TYPE_FADEE"></span><span class="target" id="lv__draw__mask_8h_1aba01db17f4a2bfbc3db60dc172972a25a9840374b90a6a1d3c6c2697802aff5bc"></span><em class="property"><span class="pre">enumerator</span> </em><code class="sig-name descname"><span class="pre">LV_DRAW_MASK_TYPE_FADE</span></code><a class="headerlink" href="#_CPPv4NUt2_1522LV_DRAW_MASK_TYPE_FADEE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_1521LV_DRAW_MASK_TYPE_MAPE">
<span id="_CPPv3NUt2_1521LV_DRAW_MASK_TYPE_MAPE"></span><span class="target" id="lv__draw__mask_8h_1aba01db17f4a2bfbc3db60dc172972a25aa6be0c465857be1090fbc0e6333b213c"></span><em class="property"><span class="pre">enumerator</span> </em><code class="sig-name descname"><span class="pre">LV_DRAW_MASK_TYPE_MAP</span></code><a class="headerlink" href="#_CPPv4NUt2_1521LV_DRAW_MASK_TYPE_MAPE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

</dd></dl>

<dl class="cpp enum">
<dt id="_CPPv4Ut2_16">
<span id="_CPPv3Ut2_16"></span><span class="target" id="lv__draw__mask_8h_1aaf105ae5beaca1dee30ae54530691fce"></span><em class="property"><span class="pre">enum</span> </em><strong><span class="pre">[anonymous]</span></strong><a class="headerlink" href="#_CPPv4Ut2_16" title="Permalink to this definition">¶</a><br /></dt>
<dd><p><em>Values:</em></p>
<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_1627LV_DRAW_MASK_LINE_SIDE_LEFTE">
<span id="_CPPv3NUt2_1627LV_DRAW_MASK_LINE_SIDE_LEFTE"></span><span class="target" id="lv__draw__mask_8h_1aaf105ae5beaca1dee30ae54530691fceaab08d97f9263895f5706f9ed05b787ef"></span><em class="property"><span class="pre">enumerator</span> </em><code class="sig-name descname"><span class="pre">LV_DRAW_MASK_LINE_SIDE_LEFT</span></code><a class="headerlink" href="#_CPPv4NUt2_1627LV_DRAW_MASK_LINE_SIDE_LEFTE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_1628LV_DRAW_MASK_LINE_SIDE_RIGHTE">
<span id="_CPPv3NUt2_1628LV_DRAW_MASK_LINE_SIDE_RIGHTE"></span><span class="target" id="lv__draw__mask_8h_1aaf105ae5beaca1dee30ae54530691fceac94bfa9279d127967c9546bc9bdb0375"></span><em class="property"><span class="pre">enumerator</span> </em><code class="sig-name descname"><span class="pre">LV_DRAW_MASK_LINE_SIDE_RIGHT</span></code><a class="headerlink" href="#_CPPv4NUt2_1628LV_DRAW_MASK_LINE_SIDE_RIGHTE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_1626LV_DRAW_MASK_LINE_SIDE_TOPE">
<span id="_CPPv3NUt2_1626LV_DRAW_MASK_LINE_SIDE_TOPE"></span><span class="target" id="lv__draw__mask_8h_1aaf105ae5beaca1dee30ae54530691fceac5045fe02e85235f725eca795f21be3a"></span><em class="property"><span class="pre">enumerator</span> </em><code class="sig-name descname"><span class="pre">LV_DRAW_MASK_LINE_SIDE_TOP</span></code><a class="headerlink" href="#_CPPv4NUt2_1626LV_DRAW_MASK_LINE_SIDE_TOPE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_1629LV_DRAW_MASK_LINE_SIDE_BOTTOME">
<span id="_CPPv3NUt2_1629LV_DRAW_MASK_LINE_SIDE_BOTTOME"></span><span class="target" id="lv__draw__mask_8h_1aaf105ae5beaca1dee30ae54530691fcea6e448089e0a9f013e359a7a72cdd49a8"></span><em class="property"><span class="pre">enumerator</span> </em><code class="sig-name descname"><span class="pre">LV_DRAW_MASK_LINE_SIDE_BOTTOM</span></code><a class="headerlink" href="#_CPPv4NUt2_1629LV_DRAW_MASK_LINE_SIDE_BOTTOME" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

</dd></dl>

</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-functions">Functions</p>
<dl class="cpp function">
<dt id="_CPPv416lv_draw_mask_addPvPv">
<span id="_CPPv316lv_draw_mask_addPvPv"></span><span id="_CPPv216lv_draw_mask_addPvPv"></span><span id="lv_draw_mask_add__voidP.voidP"></span><span class="target" id="lv__draw__mask_8h_1a0c6e2dfc4102853ccd17a96d7dd2c9a9"></span><span class="pre">int16_t</span> <code class="sig-name descname"><span class="pre">lv_draw_mask_add</span></code><span class="sig-paren">(</span><span class="pre">void</span> <span class="pre">*</span><em><span class="pre">param</span></em>, <span class="pre">void</span> <span class="pre">*</span><em><span class="pre">custom_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv416lv_draw_mask_addPvPv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Add a draw mask. Everything drawn after it (until removing the mask) will be affected by the mask. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>param</strong> -- an initialized mask parameter. Only the pointer is saved. </p></li>
<li><p><strong>custom_id</strong> -- a custom pointer to identify the mask. Used in <code class="docutils literal notranslate"><span class="pre">lv_draw_mask_remove_custom</span></code>. </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>the an integer, the ID of the mask. Can be used in <code class="docutils literal notranslate"><span class="pre">lv_draw_mask_remove_id</span></code>. </p>
</dd>
</dl>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv422lv_draw_mask_remove_id7int16_t">
<span id="_CPPv322lv_draw_mask_remove_id7int16_t"></span><span id="_CPPv222lv_draw_mask_remove_id7int16_t"></span><span id="lv_draw_mask_remove_id__int16_t"></span><span class="target" id="lv__draw__mask_8h_1a7008c1b54a4fc1e40aaf1997e73a5006"></span><span class="pre">void</span> <span class="pre">*</span><code class="sig-name descname"><span class="pre">lv_draw_mask_remove_id</span></code><span class="sig-paren">(</span><span class="pre">int16_t</span> <em><span class="pre">id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv422lv_draw_mask_remove_id7int16_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Remove a mask with a given ID </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> -- the ID of the mask. Returned by <code class="docutils literal notranslate"><span class="pre">lv_draw_mask_add</span></code> </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>the parameter of the removed mask. If more masks have <code class="docutils literal notranslate"><span class="pre">custom_id</span></code> ID then the last mask's parameter will be returned </p>
</dd>
</dl>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv426lv_draw_mask_remove_customPv">
<span id="_CPPv326lv_draw_mask_remove_customPv"></span><span id="_CPPv226lv_draw_mask_remove_customPv"></span><span id="lv_draw_mask_remove_custom__voidP"></span><span class="target" id="lv__draw__mask_8h_1af7af6d04b5bcc9b79fafe8c800cc0497"></span><span class="pre">void</span> <span class="pre">*</span><code class="sig-name descname"><span class="pre">lv_draw_mask_remove_custom</span></code><span class="sig-paren">(</span><span class="pre">void</span> <span class="pre">*</span><em><span class="pre">custom_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv426lv_draw_mask_remove_customPv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Remove all mask with a given custom ID </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>custom_id</strong> -- a pointer used in <code class="docutils literal notranslate"><span class="pre">lv_draw_mask_add</span></code> </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>return the parameter of the removed mask. If more masks have <code class="docutils literal notranslate"><span class="pre">custom_id</span></code> ID then the last mask's parameter will be returned </p>
</dd>
</dl>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv429lv_draw_mask_line_points_initP25lv_draw_mask_line_param_t10lv_coord_t10lv_coord_t10lv_coord_t10lv_coord_t24lv_draw_mask_line_side_t">
<span id="_CPPv329lv_draw_mask_line_points_initP25lv_draw_mask_line_param_t10lv_coord_t10lv_coord_t10lv_coord_t10lv_coord_t24lv_draw_mask_line_side_t"></span><span id="_CPPv229lv_draw_mask_line_points_initP25lv_draw_mask_line_param_t10lv_coord_t10lv_coord_t10lv_coord_t10lv_coord_t24lv_draw_mask_line_side_t"></span><span id="lv_draw_mask_line_points_init__lv_draw_mask_line_param_tP.lv_coord_t.lv_coord_t.lv_coord_t.lv_coord_t.lv_draw_mask_line_side_t"></span><span class="target" id="lv__draw__mask_8h_1a10895b1f7ad1987cde8db1f20697605b"></span><span class="pre">void</span> <code class="sig-name descname"><span class="pre">lv_draw_mask_line_points_init</span></code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv425lv_draw_mask_line_param_t" title="lv_draw_mask_line_param_t"><span class="pre">lv_draw_mask_line_param_t</span></a> <span class="pre">*</span><em><span class="pre">param</span></em>, <span class="pre">lv_coord_t</span> <em><span class="pre">p1x</span></em>, <span class="pre">lv_coord_t</span> <em><span class="pre">p1y</span></em>, <span class="pre">lv_coord_t</span> <em><span class="pre">p2x</span></em>, <span class="pre">lv_coord_t</span> <em><span class="pre">p2y</span></em>, <a class="reference internal" href="#_CPPv424lv_draw_mask_line_side_t" title="lv_draw_mask_line_side_t"><span class="pre">lv_draw_mask_line_side_t</span></a> <em><span class="pre">side</span></em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv429lv_draw_mask_line_points_initP25lv_draw_mask_line_param_t10lv_coord_t10lv_coord_t10lv_coord_t10lv_coord_t24lv_draw_mask_line_side_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Initialize a line mask from two points. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>param</strong> -- pointer to a <code class="docutils literal notranslate"><span class="pre">lv_draw_mask_param_t</span></code> to initialize </p></li>
<li><p><strong>p1x</strong> -- X coordinate of the first point of the line </p></li>
<li><p><strong>p1y</strong> -- Y coordinate of the first point of the line </p></li>
<li><p><strong>p2x</strong> -- X coordinate of the second point of the line </p></li>
<li><p><strong>p2y</strong> -- y coordinate of the second point of the line </p></li>
<li><p><strong>side</strong> -- and element of <code class="docutils literal notranslate"><span class="pre">lv_draw_mask_line_side_t</span></code> to describe which side to keep. With <code class="docutils literal notranslate"><span class="pre">LV_DRAW_MASK_LINE_SIDE_LEFT/RIGHT</span></code> and horizontal line all pixels are kept With <code class="docutils literal notranslate"><span class="pre">LV_DRAW_MASK_LINE_SIDE_TOP/BOTTOM</span></code> and vertical line all pixels are kept </p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv428lv_draw_mask_line_angle_initP25lv_draw_mask_line_param_t10lv_coord_t10lv_coord_t7int16_t24lv_draw_mask_line_side_t">
<span id="_CPPv328lv_draw_mask_line_angle_initP25lv_draw_mask_line_param_t10lv_coord_t10lv_coord_t7int16_t24lv_draw_mask_line_side_t"></span><span id="_CPPv228lv_draw_mask_line_angle_initP25lv_draw_mask_line_param_t10lv_coord_t10lv_coord_t7int16_t24lv_draw_mask_line_side_t"></span><span id="lv_draw_mask_line_angle_init__lv_draw_mask_line_param_tP.lv_coord_t.lv_coord_t.int16_t.lv_draw_mask_line_side_t"></span><span class="target" id="lv__draw__mask_8h_1a0f2d06c0a3a67d54f9d044c5b7cc9eb1"></span><span class="pre">void</span> <code class="sig-name descname"><span class="pre">lv_draw_mask_line_angle_init</span></code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv425lv_draw_mask_line_param_t" title="lv_draw_mask_line_param_t"><span class="pre">lv_draw_mask_line_param_t</span></a> <span class="pre">*</span><em><span class="pre">param</span></em>, <span class="pre">lv_coord_t</span> <em><span class="pre">p1x</span></em>, <span class="pre">lv_coord_t</span> <em><span class="pre">py</span></em>, <span class="pre">int16_t</span> <em><span class="pre">angle</span></em>, <a class="reference internal" href="#_CPPv424lv_draw_mask_line_side_t" title="lv_draw_mask_line_side_t"><span class="pre">lv_draw_mask_line_side_t</span></a> <em><span class="pre">side</span></em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv428lv_draw_mask_line_angle_initP25lv_draw_mask_line_param_t10lv_coord_t10lv_coord_t7int16_t24lv_draw_mask_line_side_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Initialize a line mask from a point and an angle. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>param</strong> -- pointer to a <code class="docutils literal notranslate"><span class="pre">lv_draw_mask_param_t</span></code> to initialize </p></li>
<li><p><strong>px</strong> -- X coordinate of a point of the line </p></li>
<li><p><strong>py</strong> -- X coordinate of a point of the line </p></li>
<li><p><strong>angle</strong> -- right 0 deg, bottom: 90 </p></li>
<li><p><strong>side</strong> -- and element of <code class="docutils literal notranslate"><span class="pre">lv_draw_mask_line_side_t</span></code> to describe which side to keep. With <code class="docutils literal notranslate"><span class="pre">LV_DRAW_MASK_LINE_SIDE_LEFT/RIGHT</span></code> and horizontal line all pixels are kept With <code class="docutils literal notranslate"><span class="pre">LV_DRAW_MASK_LINE_SIDE_TOP/BOTTOM</span></code> and vertical line all pixels are kept </p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv423lv_draw_mask_angle_initP26lv_draw_mask_angle_param_t10lv_coord_t10lv_coord_t10lv_coord_t10lv_coord_t">
<span id="_CPPv323lv_draw_mask_angle_initP26lv_draw_mask_angle_param_t10lv_coord_t10lv_coord_t10lv_coord_t10lv_coord_t"></span><span id="_CPPv223lv_draw_mask_angle_initP26lv_draw_mask_angle_param_t10lv_coord_t10lv_coord_t10lv_coord_t10lv_coord_t"></span><span id="lv_draw_mask_angle_init__lv_draw_mask_angle_param_tP.lv_coord_t.lv_coord_t.lv_coord_t.lv_coord_t"></span><span class="target" id="lv__draw__mask_8h_1a907fedb356b36ce3b3b8439e1f8f7323"></span><span class="pre">void</span> <code class="sig-name descname"><span class="pre">lv_draw_mask_angle_init</span></code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv426lv_draw_mask_angle_param_t" title="lv_draw_mask_angle_param_t"><span class="pre">lv_draw_mask_angle_param_t</span></a> <span class="pre">*</span><em><span class="pre">param</span></em>, <span class="pre">lv_coord_t</span> <em><span class="pre">vertex_x</span></em>, <span class="pre">lv_coord_t</span> <em><span class="pre">vertex_y</span></em>, <span class="pre">lv_coord_t</span> <em><span class="pre">start_angle</span></em>, <span class="pre">lv_coord_t</span> <em><span class="pre">end_angle</span></em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv423lv_draw_mask_angle_initP26lv_draw_mask_angle_param_t10lv_coord_t10lv_coord_t10lv_coord_t10lv_coord_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Initialize an angle mask. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>param</strong> -- pointer to a <code class="docutils literal notranslate"><span class="pre">lv_draw_mask_param_t</span></code> to initialize </p></li>
<li><p><strong>vertex_x</strong> -- X coordinate of the angle vertex (absolute coordinates) </p></li>
<li><p><strong>vertex_y</strong> -- Y coordinate of the angle vertex (absolute coordinates) </p></li>
<li><p><strong>start_angle</strong> -- start angle in degrees. 0 deg on the right, 90 deg, on the bottom </p></li>
<li><p><strong>end_angle</strong> -- end angle </p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv424lv_draw_mask_radius_initP27lv_draw_mask_radius_param_tPK9lv_area_t10lv_coord_tb">
<span id="_CPPv324lv_draw_mask_radius_initP27lv_draw_mask_radius_param_tPK9lv_area_t10lv_coord_tb"></span><span id="_CPPv224lv_draw_mask_radius_initP27lv_draw_mask_radius_param_tPK9lv_area_t10lv_coord_tb"></span><span id="lv_draw_mask_radius_init__lv_draw_mask_radius_param_tP.lv_area_tCP.lv_coord_t.b"></span><span class="target" id="lv__draw__mask_8h_1a88f1cbdf8f0e107075536d0a07f511bf"></span><span class="pre">void</span> <code class="sig-name descname"><span class="pre">lv_draw_mask_radius_init</span></code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv427lv_draw_mask_radius_param_t" title="lv_draw_mask_radius_param_t"><span class="pre">lv_draw_mask_radius_param_t</span></a> <span class="pre">*</span><em><span class="pre">param</span></em>, <em class="property"><span class="pre">const</span></em> <span class="pre">lv_area_t</span> <span class="pre">*</span><em><span class="pre">rect</span></em>, <span class="pre">lv_coord_t</span> <em><span class="pre">radius</span></em>, <span class="pre">bool</span> <em><span class="pre">inv</span></em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv424lv_draw_mask_radius_initP27lv_draw_mask_radius_param_tPK9lv_area_t10lv_coord_tb" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Initialize a fade mask. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>param</strong> -- param pointer to a <code class="docutils literal notranslate"><span class="pre">lv_draw_mask_param_t</span></code> to initialize </p></li>
<li><p><strong>rect</strong> -- coordinates of the rectangle to affect (absolute coordinates) </p></li>
<li><p><strong>radius</strong> -- radius of the rectangle </p></li>
<li><p><strong>inv</strong> -- true: keep the pixels inside the rectangle; keep the pixels outside of the rectangle </p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv422lv_draw_mask_fade_initP25lv_draw_mask_fade_param_tPK9lv_area_t8lv_opa_t10lv_coord_t8lv_opa_t10lv_coord_t">
<span id="_CPPv322lv_draw_mask_fade_initP25lv_draw_mask_fade_param_tPK9lv_area_t8lv_opa_t10lv_coord_t8lv_opa_t10lv_coord_t"></span><span id="_CPPv222lv_draw_mask_fade_initP25lv_draw_mask_fade_param_tPK9lv_area_t8lv_opa_t10lv_coord_t8lv_opa_t10lv_coord_t"></span><span id="lv_draw_mask_fade_init__lv_draw_mask_fade_param_tP.lv_area_tCP.lv_opa_t.lv_coord_t.lv_opa_t.lv_coord_t"></span><span class="target" id="lv__draw__mask_8h_1a9d0ceeba92eebec614ba26caa28fa09c"></span><span class="pre">void</span> <code class="sig-name descname"><span class="pre">lv_draw_mask_fade_init</span></code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv425lv_draw_mask_fade_param_t" title="lv_draw_mask_fade_param_t"><span class="pre">lv_draw_mask_fade_param_t</span></a> <span class="pre">*</span><em><span class="pre">param</span></em>, <em class="property"><span class="pre">const</span></em> <span class="pre">lv_area_t</span> <span class="pre">*</span><em><span class="pre">coords</span></em>, <span class="pre">lv_opa_t</span> <em><span class="pre">opa_top</span></em>, <span class="pre">lv_coord_t</span> <em><span class="pre">y_top</span></em>, <span class="pre">lv_opa_t</span> <em><span class="pre">opa_bottom</span></em>, <span class="pre">lv_coord_t</span> <em><span class="pre">y_bottom</span></em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv422lv_draw_mask_fade_initP25lv_draw_mask_fade_param_tPK9lv_area_t8lv_opa_t10lv_coord_t8lv_opa_t10lv_coord_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Initialize a fade mask. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>param</strong> -- pointer to a <code class="docutils literal notranslate"><span class="pre">lv_draw_mask_param_t</span></code> to initialize </p></li>
<li><p><strong>coords</strong> -- coordinates of the area to affect (absolute coordinates) </p></li>
<li><p><strong>opa_top</strong> -- opacity on the top </p></li>
<li><p><strong>y_top</strong> -- at which coordinate start to change to opacity to <code class="docutils literal notranslate"><span class="pre">opa_bottom</span></code> </p></li>
<li><p><strong>opa_bottom</strong> -- opacity at the bottom </p></li>
<li><p><strong>y_bottom</strong> -- at which coordinate reach <code class="docutils literal notranslate"><span class="pre">opa_bottom</span></code>. </p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv421lv_draw_mask_map_initP24lv_draw_mask_map_param_tPK9lv_area_tPK8lv_opa_t">
<span id="_CPPv321lv_draw_mask_map_initP24lv_draw_mask_map_param_tPK9lv_area_tPK8lv_opa_t"></span><span id="_CPPv221lv_draw_mask_map_initP24lv_draw_mask_map_param_tPK9lv_area_tPK8lv_opa_t"></span><span id="lv_draw_mask_map_init__lv_draw_mask_map_param_tP.lv_area_tCP.lv_opa_tCP"></span><span class="target" id="lv__draw__mask_8h_1ad57c7043552454bda24fc1e549273a9e"></span><span class="pre">void</span> <code class="sig-name descname"><span class="pre">lv_draw_mask_map_init</span></code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv424lv_draw_mask_map_param_t" title="lv_draw_mask_map_param_t"><span class="pre">lv_draw_mask_map_param_t</span></a> <span class="pre">*</span><em><span class="pre">param</span></em>, <em class="property"><span class="pre">const</span></em> <span class="pre">lv_area_t</span> <span class="pre">*</span><em><span class="pre">coords</span></em>, <em class="property"><span class="pre">const</span></em> <span class="pre">lv_opa_t</span> <span class="pre">*</span><em><span class="pre">map</span></em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv421lv_draw_mask_map_initP24lv_draw_mask_map_param_tPK9lv_area_tPK8lv_opa_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Initialize a map mask. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>param</strong> -- pointer to a <code class="docutils literal notranslate"><span class="pre">lv_draw_mask_param_t</span></code> to initialize </p></li>
<li><p><strong>coords</strong> -- coordinates of the map (absolute coordinates) </p></li>
<li><p><strong>map</strong> -- array of bytes with the mask values </p></li>
</ul>
</dd>
</dl>
</dd></dl>

</div>
<dl class="cpp struct">
<dt id="_CPPv425lv_draw_mask_common_dsc_t">
<span id="_CPPv325lv_draw_mask_common_dsc_t"></span><span id="_CPPv225lv_draw_mask_common_dsc_t"></span><span id="lv_draw_mask_common_dsc_t"></span><span class="target" id="structlv__draw__mask__common__dsc__t"></span><em class="property"><span class="pre">struct</span> </em><code class="sig-name descname"><span class="pre">lv_draw_mask_common_dsc_t</span></code><a class="headerlink" href="#_CPPv425lv_draw_mask_common_dsc_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p>
<dl class="cpp var">
<dt id="_CPPv4N25lv_draw_mask_common_dsc_t2cbE">
<span id="_CPPv3N25lv_draw_mask_common_dsc_t2cbE"></span><span id="_CPPv2N25lv_draw_mask_common_dsc_t2cbE"></span><span id="lv_draw_mask_common_dsc_t::cb__lv_draw_mask_xcb_t"></span><span class="target" id="structlv__draw__mask__common__dsc__t_1afc304385d94d75f5e70150399a66c51d"></span><a class="reference internal" href="#_CPPv418lv_draw_mask_xcb_t" title="lv_draw_mask_xcb_t"><span class="pre">lv_draw_mask_xcb_t</span></a> <code class="sig-name descname"><span class="pre">cb</span></code><a class="headerlink" href="#_CPPv4N25lv_draw_mask_common_dsc_t2cbE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N25lv_draw_mask_common_dsc_t4typeE">
<span id="_CPPv3N25lv_draw_mask_common_dsc_t4typeE"></span><span id="_CPPv2N25lv_draw_mask_common_dsc_t4typeE"></span><span id="lv_draw_mask_common_dsc_t::type__lv_draw_mask_type_t"></span><span class="target" id="structlv__draw__mask__common__dsc__t_1ac387f316de0c640f5c522006e0eb8e00"></span><a class="reference internal" href="#_CPPv419lv_draw_mask_type_t" title="lv_draw_mask_type_t"><span class="pre">lv_draw_mask_type_t</span></a> <code class="sig-name descname"><span class="pre">type</span></code><a class="headerlink" href="#_CPPv4N25lv_draw_mask_common_dsc_t4typeE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

</div>
</dd></dl>

<dl class="cpp struct">
<dt id="_CPPv425lv_draw_mask_line_param_t">
<span id="_CPPv325lv_draw_mask_line_param_t"></span><span id="_CPPv225lv_draw_mask_line_param_t"></span><span id="lv_draw_mask_line_param_t"></span><span class="target" id="structlv__draw__mask__line__param__t"></span><em class="property"><span class="pre">struct</span> </em><code class="sig-name descname"><span class="pre">lv_draw_mask_line_param_t</span></code><a class="headerlink" href="#_CPPv425lv_draw_mask_line_param_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p>
<dl class="cpp var">
<dt id="_CPPv4N25lv_draw_mask_line_param_t3dscE">
<span id="_CPPv3N25lv_draw_mask_line_param_t3dscE"></span><span id="_CPPv2N25lv_draw_mask_line_param_t3dscE"></span><span id="lv_draw_mask_line_param_t::dsc__lv_draw_mask_common_dsc_t"></span><span class="target" id="structlv__draw__mask__line__param__t_1a670f2723b483580a788958607abe02ef"></span><a class="reference internal" href="#_CPPv425lv_draw_mask_common_dsc_t" title="lv_draw_mask_common_dsc_t"><span class="pre">lv_draw_mask_common_dsc_t</span></a> <code class="sig-name descname"><span class="pre">dsc</span></code><a class="headerlink" href="#_CPPv4N25lv_draw_mask_line_param_t3dscE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N25lv_draw_mask_line_param_t2p1E">
<span id="_CPPv3N25lv_draw_mask_line_param_t2p1E"></span><span id="_CPPv2N25lv_draw_mask_line_param_t2p1E"></span><span id="lv_draw_mask_line_param_t::p1__lv_point_t"></span><span class="target" id="structlv__draw__mask__line__param__t_1a76f8fa24fafabdd55b00a6f4017f725a"></span><span class="pre">lv_point_t</span> <code class="sig-name descname"><span class="pre">p1</span></code><a class="headerlink" href="#_CPPv4N25lv_draw_mask_line_param_t2p1E" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N25lv_draw_mask_line_param_t2p2E">
<span id="_CPPv3N25lv_draw_mask_line_param_t2p2E"></span><span id="_CPPv2N25lv_draw_mask_line_param_t2p2E"></span><span id="lv_draw_mask_line_param_t::p2__lv_point_t"></span><span class="target" id="structlv__draw__mask__line__param__t_1a97c59a5e03609a722b5d099fa4c294c3"></span><span class="pre">lv_point_t</span> <code class="sig-name descname"><span class="pre">p2</span></code><a class="headerlink" href="#_CPPv4N25lv_draw_mask_line_param_t2p2E" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N25lv_draw_mask_line_param_t4sideE">
<span id="_CPPv3N25lv_draw_mask_line_param_t4sideE"></span><span id="_CPPv2N25lv_draw_mask_line_param_t4sideE"></span><span id="lv_draw_mask_line_param_t::side__lv_draw_mask_line_side_t"></span><span class="target" id="structlv__draw__mask__line__param__t_1a3fab5b2a3c244b6f800e2914c2704af1"></span><a class="reference internal" href="#_CPPv424lv_draw_mask_line_side_t" title="lv_draw_mask_line_side_t"><span class="pre">lv_draw_mask_line_side_t</span></a> <code class="sig-name descname"><span class="pre">side</span></code><a class="headerlink" href="#_CPPv4N25lv_draw_mask_line_param_t4sideE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N25lv_draw_mask_line_param_t3cfgE">
<span id="_CPPv3N25lv_draw_mask_line_param_t3cfgE"></span><span id="_CPPv2N25lv_draw_mask_line_param_t3cfgE"></span><span class="target" id="structlv__draw__mask__line__param__t_1a1fa973d6806a6e59329b1c260d0c6788"></span><em class="property"><span class="pre">struct</span></em> <a class="reference internal" href="#_CPPv425lv_draw_mask_line_param_t" title="lv_draw_mask_line_param_t"><span class="pre">lv_draw_mask_line_param_t</span></a><span class="pre">::</span><strong><span class="pre">[anonymous]</span></strong> <code class="sig-name descname"><span class="pre">cfg</span></code><a class="headerlink" href="#_CPPv4N25lv_draw_mask_line_param_t3cfgE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N25lv_draw_mask_line_param_t5origoE">
<span id="_CPPv3N25lv_draw_mask_line_param_t5origoE"></span><span id="_CPPv2N25lv_draw_mask_line_param_t5origoE"></span><span id="lv_draw_mask_line_param_t::origo__lv_point_t"></span><span class="target" id="structlv__draw__mask__line__param__t_1a2d1c4a4b94da87d3d518d7a1520a688c"></span><span class="pre">lv_point_t</span> <code class="sig-name descname"><span class="pre">origo</span></code><a class="headerlink" href="#_CPPv4N25lv_draw_mask_line_param_t5origoE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N25lv_draw_mask_line_param_t8xy_steepE">
<span id="_CPPv3N25lv_draw_mask_line_param_t8xy_steepE"></span><span id="_CPPv2N25lv_draw_mask_line_param_t8xy_steepE"></span><span id="lv_draw_mask_line_param_t::xy_steep__int32_t"></span><span class="target" id="structlv__draw__mask__line__param__t_1a9cee4d800cbada1a67c059e46e735e18"></span><span class="pre">int32_t</span> <code class="sig-name descname"><span class="pre">xy_steep</span></code><a class="headerlink" href="#_CPPv4N25lv_draw_mask_line_param_t8xy_steepE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N25lv_draw_mask_line_param_t8yx_steepE">
<span id="_CPPv3N25lv_draw_mask_line_param_t8yx_steepE"></span><span id="_CPPv2N25lv_draw_mask_line_param_t8yx_steepE"></span><span id="lv_draw_mask_line_param_t::yx_steep__int32_t"></span><span class="target" id="structlv__draw__mask__line__param__t_1a82939d8751289f14c4117073a7cf58bd"></span><span class="pre">int32_t</span> <code class="sig-name descname"><span class="pre">yx_steep</span></code><a class="headerlink" href="#_CPPv4N25lv_draw_mask_line_param_t8yx_steepE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N25lv_draw_mask_line_param_t5steepE">
<span id="_CPPv3N25lv_draw_mask_line_param_t5steepE"></span><span id="_CPPv2N25lv_draw_mask_line_param_t5steepE"></span><span id="lv_draw_mask_line_param_t::steep__int32_t"></span><span class="target" id="structlv__draw__mask__line__param__t_1a2527c429dad6224788a391fde2c5a699"></span><span class="pre">int32_t</span> <code class="sig-name descname"><span class="pre">steep</span></code><a class="headerlink" href="#_CPPv4N25lv_draw_mask_line_param_t5steepE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N25lv_draw_mask_line_param_t3spxE">
<span id="_CPPv3N25lv_draw_mask_line_param_t3spxE"></span><span id="_CPPv2N25lv_draw_mask_line_param_t3spxE"></span><span id="lv_draw_mask_line_param_t::spx__int32_t"></span><span class="target" id="structlv__draw__mask__line__param__t_1a1844cb14edd45cff3ea7bb5e672dc02b"></span><span class="pre">int32_t</span> <code class="sig-name descname"><span class="pre">spx</span></code><a class="headerlink" href="#_CPPv4N25lv_draw_mask_line_param_t3spxE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N25lv_draw_mask_line_param_t4flatE">
<span id="_CPPv3N25lv_draw_mask_line_param_t4flatE"></span><span id="_CPPv2N25lv_draw_mask_line_param_t4flatE"></span><span id="lv_draw_mask_line_param_t::flat__uint8_t"></span><span class="target" id="structlv__draw__mask__line__param__t_1a8c110a9349663ae463aa19e806886505"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">flat</span></code><a class="headerlink" href="#_CPPv4N25lv_draw_mask_line_param_t4flatE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N25lv_draw_mask_line_param_t3invE">
<span id="_CPPv3N25lv_draw_mask_line_param_t3invE"></span><span id="_CPPv2N25lv_draw_mask_line_param_t3invE"></span><span id="lv_draw_mask_line_param_t::inv__uint8_t"></span><span class="target" id="structlv__draw__mask__line__param__t_1a8c9209e9a677a452ff84584ee0489eb6"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">inv</span></code><a class="headerlink" href="#_CPPv4N25lv_draw_mask_line_param_t3invE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

</div>
</dd></dl>

<dl class="cpp struct">
<dt id="_CPPv426lv_draw_mask_angle_param_t">
<span id="_CPPv326lv_draw_mask_angle_param_t"></span><span id="_CPPv226lv_draw_mask_angle_param_t"></span><span id="lv_draw_mask_angle_param_t"></span><span class="target" id="structlv__draw__mask__angle__param__t"></span><em class="property"><span class="pre">struct</span> </em><code class="sig-name descname"><span class="pre">lv_draw_mask_angle_param_t</span></code><a class="headerlink" href="#_CPPv426lv_draw_mask_angle_param_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p>
<dl class="cpp var">
<dt id="_CPPv4N26lv_draw_mask_angle_param_t3dscE">
<span id="_CPPv3N26lv_draw_mask_angle_param_t3dscE"></span><span id="_CPPv2N26lv_draw_mask_angle_param_t3dscE"></span><span id="lv_draw_mask_angle_param_t::dsc__lv_draw_mask_common_dsc_t"></span><span class="target" id="structlv__draw__mask__angle__param__t_1acc8c24d1ef964372c43ecdd30818490c"></span><a class="reference internal" href="#_CPPv425lv_draw_mask_common_dsc_t" title="lv_draw_mask_common_dsc_t"><span class="pre">lv_draw_mask_common_dsc_t</span></a> <code class="sig-name descname"><span class="pre">dsc</span></code><a class="headerlink" href="#_CPPv4N26lv_draw_mask_angle_param_t3dscE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N26lv_draw_mask_angle_param_t8vertex_pE">
<span id="_CPPv3N26lv_draw_mask_angle_param_t8vertex_pE"></span><span id="_CPPv2N26lv_draw_mask_angle_param_t8vertex_pE"></span><span id="lv_draw_mask_angle_param_t::vertex_p__lv_point_t"></span><span class="target" id="structlv__draw__mask__angle__param__t_1ae872c8002ec7032c7e9c0345da19618d"></span><span class="pre">lv_point_t</span> <code class="sig-name descname"><span class="pre">vertex_p</span></code><a class="headerlink" href="#_CPPv4N26lv_draw_mask_angle_param_t8vertex_pE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N26lv_draw_mask_angle_param_t11start_angleE">
<span id="_CPPv3N26lv_draw_mask_angle_param_t11start_angleE"></span><span id="_CPPv2N26lv_draw_mask_angle_param_t11start_angleE"></span><span id="lv_draw_mask_angle_param_t::start_angle__lv_coord_t"></span><span class="target" id="structlv__draw__mask__angle__param__t_1a7642e10e39556ead2826102a75cf182b"></span><span class="pre">lv_coord_t</span> <code class="sig-name descname"><span class="pre">start_angle</span></code><a class="headerlink" href="#_CPPv4N26lv_draw_mask_angle_param_t11start_angleE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N26lv_draw_mask_angle_param_t9end_angleE">
<span id="_CPPv3N26lv_draw_mask_angle_param_t9end_angleE"></span><span id="_CPPv2N26lv_draw_mask_angle_param_t9end_angleE"></span><span id="lv_draw_mask_angle_param_t::end_angle__lv_coord_t"></span><span class="target" id="structlv__draw__mask__angle__param__t_1af4f1bcd1afbb7dafcf7b6e314b089bf1"></span><span class="pre">lv_coord_t</span> <code class="sig-name descname"><span class="pre">end_angle</span></code><a class="headerlink" href="#_CPPv4N26lv_draw_mask_angle_param_t9end_angleE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N26lv_draw_mask_angle_param_t3cfgE">
<span id="_CPPv3N26lv_draw_mask_angle_param_t3cfgE"></span><span id="_CPPv2N26lv_draw_mask_angle_param_t3cfgE"></span><span class="target" id="structlv__draw__mask__angle__param__t_1a4eeef380748ee927dabe013c2816f1cc"></span><em class="property"><span class="pre">struct</span></em> <a class="reference internal" href="#_CPPv426lv_draw_mask_angle_param_t" title="lv_draw_mask_angle_param_t"><span class="pre">lv_draw_mask_angle_param_t</span></a><span class="pre">::</span><strong><span class="pre">[anonymous]</span></strong> <code class="sig-name descname"><span class="pre">cfg</span></code><a class="headerlink" href="#_CPPv4N26lv_draw_mask_angle_param_t3cfgE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N26lv_draw_mask_angle_param_t10start_lineE">
<span id="_CPPv3N26lv_draw_mask_angle_param_t10start_lineE"></span><span id="_CPPv2N26lv_draw_mask_angle_param_t10start_lineE"></span><span id="lv_draw_mask_angle_param_t::start_line__lv_draw_mask_line_param_t"></span><span class="target" id="structlv__draw__mask__angle__param__t_1a5d4f18248557a15cf80c072ede3e71b5"></span><a class="reference internal" href="#_CPPv425lv_draw_mask_line_param_t" title="lv_draw_mask_line_param_t"><span class="pre">lv_draw_mask_line_param_t</span></a> <code class="sig-name descname"><span class="pre">start_line</span></code><a class="headerlink" href="#_CPPv4N26lv_draw_mask_angle_param_t10start_lineE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N26lv_draw_mask_angle_param_t8end_lineE">
<span id="_CPPv3N26lv_draw_mask_angle_param_t8end_lineE"></span><span id="_CPPv2N26lv_draw_mask_angle_param_t8end_lineE"></span><span id="lv_draw_mask_angle_param_t::end_line__lv_draw_mask_line_param_t"></span><span class="target" id="structlv__draw__mask__angle__param__t_1a62486a0959ba7d2eb3fa91f08a73218a"></span><a class="reference internal" href="#_CPPv425lv_draw_mask_line_param_t" title="lv_draw_mask_line_param_t"><span class="pre">lv_draw_mask_line_param_t</span></a> <code class="sig-name descname"><span class="pre">end_line</span></code><a class="headerlink" href="#_CPPv4N26lv_draw_mask_angle_param_t8end_lineE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N26lv_draw_mask_angle_param_t9delta_degE">
<span id="_CPPv3N26lv_draw_mask_angle_param_t9delta_degE"></span><span id="_CPPv2N26lv_draw_mask_angle_param_t9delta_degE"></span><span id="lv_draw_mask_angle_param_t::delta_deg__uint16_t"></span><span class="target" id="structlv__draw__mask__angle__param__t_1a0047abc1cacbf5680708085b60e6e826"></span><span class="pre">uint16_t</span> <code class="sig-name descname"><span class="pre">delta_deg</span></code><a class="headerlink" href="#_CPPv4N26lv_draw_mask_angle_param_t9delta_degE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

</div>
</dd></dl>

<dl class="cpp struct">
<dt id="_CPPv427lv_draw_mask_radius_param_t">
<span id="_CPPv327lv_draw_mask_radius_param_t"></span><span id="_CPPv227lv_draw_mask_radius_param_t"></span><span id="lv_draw_mask_radius_param_t"></span><span class="target" id="structlv__draw__mask__radius__param__t"></span><em class="property"><span class="pre">struct</span> </em><code class="sig-name descname"><span class="pre">lv_draw_mask_radius_param_t</span></code><a class="headerlink" href="#_CPPv427lv_draw_mask_radius_param_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p>
<dl class="cpp var">
<dt id="_CPPv4N27lv_draw_mask_radius_param_t3dscE">
<span id="_CPPv3N27lv_draw_mask_radius_param_t3dscE"></span><span id="_CPPv2N27lv_draw_mask_radius_param_t3dscE"></span><span id="lv_draw_mask_radius_param_t::dsc__lv_draw_mask_common_dsc_t"></span><span class="target" id="structlv__draw__mask__radius__param__t_1abaedc86202582b980d3215de6acca1d9"></span><a class="reference internal" href="#_CPPv425lv_draw_mask_common_dsc_t" title="lv_draw_mask_common_dsc_t"><span class="pre">lv_draw_mask_common_dsc_t</span></a> <code class="sig-name descname"><span class="pre">dsc</span></code><a class="headerlink" href="#_CPPv4N27lv_draw_mask_radius_param_t3dscE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N27lv_draw_mask_radius_param_t4rectE">
<span id="_CPPv3N27lv_draw_mask_radius_param_t4rectE"></span><span id="_CPPv2N27lv_draw_mask_radius_param_t4rectE"></span><span id="lv_draw_mask_radius_param_t::rect__lv_area_t"></span><span class="target" id="structlv__draw__mask__radius__param__t_1ad4ad1433c6ba53c7f4b588cfcb2e49b7"></span><span class="pre">lv_area_t</span> <code class="sig-name descname"><span class="pre">rect</span></code><a class="headerlink" href="#_CPPv4N27lv_draw_mask_radius_param_t4rectE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N27lv_draw_mask_radius_param_t6radiusE">
<span id="_CPPv3N27lv_draw_mask_radius_param_t6radiusE"></span><span id="_CPPv2N27lv_draw_mask_radius_param_t6radiusE"></span><span id="lv_draw_mask_radius_param_t::radius__lv_coord_t"></span><span class="target" id="structlv__draw__mask__radius__param__t_1af7f7173d233428b722d04e26dac05336"></span><span class="pre">lv_coord_t</span> <code class="sig-name descname"><span class="pre">radius</span></code><a class="headerlink" href="#_CPPv4N27lv_draw_mask_radius_param_t6radiusE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N27lv_draw_mask_radius_param_t5outerE">
<span id="_CPPv3N27lv_draw_mask_radius_param_t5outerE"></span><span id="_CPPv2N27lv_draw_mask_radius_param_t5outerE"></span><span id="lv_draw_mask_radius_param_t::outer__uint8_t"></span><span class="target" id="structlv__draw__mask__radius__param__t_1a23ca5e80bfaa7f949dde32b42248484b"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">outer</span></code><a class="headerlink" href="#_CPPv4N27lv_draw_mask_radius_param_t5outerE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N27lv_draw_mask_radius_param_t3cfgE">
<span id="_CPPv3N27lv_draw_mask_radius_param_t3cfgE"></span><span id="_CPPv2N27lv_draw_mask_radius_param_t3cfgE"></span><span class="target" id="structlv__draw__mask__radius__param__t_1a87d9f2d350f9780a409c64287549b003"></span><em class="property"><span class="pre">struct</span></em> <a class="reference internal" href="#_CPPv427lv_draw_mask_radius_param_t" title="lv_draw_mask_radius_param_t"><span class="pre">lv_draw_mask_radius_param_t</span></a><span class="pre">::</span><strong><span class="pre">[anonymous]</span></strong> <code class="sig-name descname"><span class="pre">cfg</span></code><a class="headerlink" href="#_CPPv4N27lv_draw_mask_radius_param_t3cfgE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N27lv_draw_mask_radius_param_t6y_prevE">
<span id="_CPPv3N27lv_draw_mask_radius_param_t6y_prevE"></span><span id="_CPPv2N27lv_draw_mask_radius_param_t6y_prevE"></span><span id="lv_draw_mask_radius_param_t::y_prev__int32_t"></span><span class="target" id="structlv__draw__mask__radius__param__t_1a2f9c7b13d55396bd736c88139dda048a"></span><span class="pre">int32_t</span> <code class="sig-name descname"><span class="pre">y_prev</span></code><a class="headerlink" href="#_CPPv4N27lv_draw_mask_radius_param_t6y_prevE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N27lv_draw_mask_radius_param_t8y_prev_xE">
<span id="_CPPv3N27lv_draw_mask_radius_param_t8y_prev_xE"></span><span id="_CPPv2N27lv_draw_mask_radius_param_t8y_prev_xE"></span><span id="lv_draw_mask_radius_param_t::y_prev_x__lv_sqrt_res_t"></span><span class="target" id="structlv__draw__mask__radius__param__t_1a2c7ceedeeb6cab091968fe7fe2924d2e"></span><span class="pre">lv_sqrt_res_t</span> <code class="sig-name descname"><span class="pre">y_prev_x</span></code><a class="headerlink" href="#_CPPv4N27lv_draw_mask_radius_param_t8y_prev_xE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

</div>
</dd></dl>

<dl class="cpp struct">
<dt id="_CPPv425lv_draw_mask_fade_param_t">
<span id="_CPPv325lv_draw_mask_fade_param_t"></span><span id="_CPPv225lv_draw_mask_fade_param_t"></span><span id="lv_draw_mask_fade_param_t"></span><span class="target" id="structlv__draw__mask__fade__param__t"></span><em class="property"><span class="pre">struct</span> </em><code class="sig-name descname"><span class="pre">lv_draw_mask_fade_param_t</span></code><a class="headerlink" href="#_CPPv425lv_draw_mask_fade_param_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p>
<dl class="cpp var">
<dt id="_CPPv4N25lv_draw_mask_fade_param_t3dscE">
<span id="_CPPv3N25lv_draw_mask_fade_param_t3dscE"></span><span id="_CPPv2N25lv_draw_mask_fade_param_t3dscE"></span><span id="lv_draw_mask_fade_param_t::dsc__lv_draw_mask_common_dsc_t"></span><span class="target" id="structlv__draw__mask__fade__param__t_1a095ef407dc47fa056cfb914d4eeede86"></span><a class="reference internal" href="#_CPPv425lv_draw_mask_common_dsc_t" title="lv_draw_mask_common_dsc_t"><span class="pre">lv_draw_mask_common_dsc_t</span></a> <code class="sig-name descname"><span class="pre">dsc</span></code><a class="headerlink" href="#_CPPv4N25lv_draw_mask_fade_param_t3dscE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N25lv_draw_mask_fade_param_t6coordsE">
<span id="_CPPv3N25lv_draw_mask_fade_param_t6coordsE"></span><span id="_CPPv2N25lv_draw_mask_fade_param_t6coordsE"></span><span id="lv_draw_mask_fade_param_t::coords__lv_area_t"></span><span class="target" id="structlv__draw__mask__fade__param__t_1a8ad076c8962898c7991410e5dfa4ff4c"></span><span class="pre">lv_area_t</span> <code class="sig-name descname"><span class="pre">coords</span></code><a class="headerlink" href="#_CPPv4N25lv_draw_mask_fade_param_t6coordsE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N25lv_draw_mask_fade_param_t5y_topE">
<span id="_CPPv3N25lv_draw_mask_fade_param_t5y_topE"></span><span id="_CPPv2N25lv_draw_mask_fade_param_t5y_topE"></span><span id="lv_draw_mask_fade_param_t::y_top__lv_coord_t"></span><span class="target" id="structlv__draw__mask__fade__param__t_1aa418a2184df939d1d402d5980f919485"></span><span class="pre">lv_coord_t</span> <code class="sig-name descname"><span class="pre">y_top</span></code><a class="headerlink" href="#_CPPv4N25lv_draw_mask_fade_param_t5y_topE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N25lv_draw_mask_fade_param_t8y_bottomE">
<span id="_CPPv3N25lv_draw_mask_fade_param_t8y_bottomE"></span><span id="_CPPv2N25lv_draw_mask_fade_param_t8y_bottomE"></span><span id="lv_draw_mask_fade_param_t::y_bottom__lv_coord_t"></span><span class="target" id="structlv__draw__mask__fade__param__t_1a264b687cdb2ee6978f5a17f0ee741802"></span><span class="pre">lv_coord_t</span> <code class="sig-name descname"><span class="pre">y_bottom</span></code><a class="headerlink" href="#_CPPv4N25lv_draw_mask_fade_param_t8y_bottomE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N25lv_draw_mask_fade_param_t7opa_topE">
<span id="_CPPv3N25lv_draw_mask_fade_param_t7opa_topE"></span><span id="_CPPv2N25lv_draw_mask_fade_param_t7opa_topE"></span><span id="lv_draw_mask_fade_param_t::opa_top__lv_opa_t"></span><span class="target" id="structlv__draw__mask__fade__param__t_1a48ce29fa0aa28be92915221d8985fa8a"></span><span class="pre">lv_opa_t</span> <code class="sig-name descname"><span class="pre">opa_top</span></code><a class="headerlink" href="#_CPPv4N25lv_draw_mask_fade_param_t7opa_topE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N25lv_draw_mask_fade_param_t10opa_bottomE">
<span id="_CPPv3N25lv_draw_mask_fade_param_t10opa_bottomE"></span><span id="_CPPv2N25lv_draw_mask_fade_param_t10opa_bottomE"></span><span id="lv_draw_mask_fade_param_t::opa_bottom__lv_opa_t"></span><span class="target" id="structlv__draw__mask__fade__param__t_1a6296267b61ecfd6f784413ee672e944f"></span><span class="pre">lv_opa_t</span> <code class="sig-name descname"><span class="pre">opa_bottom</span></code><a class="headerlink" href="#_CPPv4N25lv_draw_mask_fade_param_t10opa_bottomE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N25lv_draw_mask_fade_param_t3cfgE">
<span id="_CPPv3N25lv_draw_mask_fade_param_t3cfgE"></span><span id="_CPPv2N25lv_draw_mask_fade_param_t3cfgE"></span><span class="target" id="structlv__draw__mask__fade__param__t_1a8f93cffd51940402064708ddae83cc2e"></span><em class="property"><span class="pre">struct</span></em> <a class="reference internal" href="#_CPPv425lv_draw_mask_fade_param_t" title="lv_draw_mask_fade_param_t"><span class="pre">lv_draw_mask_fade_param_t</span></a><span class="pre">::</span><strong><span class="pre">[anonymous]</span></strong> <code class="sig-name descname"><span class="pre">cfg</span></code><a class="headerlink" href="#_CPPv4N25lv_draw_mask_fade_param_t3cfgE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

</div>
</dd></dl>

<dl class="cpp struct">
<dt id="_CPPv425_lv_draw_mask_map_param_t">
<span id="_CPPv325_lv_draw_mask_map_param_t"></span><span id="_CPPv225_lv_draw_mask_map_param_t"></span><span id="_lv_draw_mask_map_param_t"></span><span class="target" id="struct__lv__draw__mask__map__param__t"></span><em class="property"><span class="pre">struct</span> </em><code class="sig-name descname"><span class="pre">_lv_draw_mask_map_param_t</span></code><a class="headerlink" href="#_CPPv425_lv_draw_mask_map_param_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p>
<dl class="cpp var">
<dt id="_CPPv4N25_lv_draw_mask_map_param_t3dscE">
<span id="_CPPv3N25_lv_draw_mask_map_param_t3dscE"></span><span id="_CPPv2N25_lv_draw_mask_map_param_t3dscE"></span><span id="_lv_draw_mask_map_param_t::dsc__lv_draw_mask_common_dsc_t"></span><span class="target" id="struct__lv__draw__mask__map__param__t_1aeaf86adff74d7b345af9c12cc0275562"></span><a class="reference internal" href="#_CPPv425lv_draw_mask_common_dsc_t" title="lv_draw_mask_common_dsc_t"><span class="pre">lv_draw_mask_common_dsc_t</span></a> <code class="sig-name descname"><span class="pre">dsc</span></code><a class="headerlink" href="#_CPPv4N25_lv_draw_mask_map_param_t3dscE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N25_lv_draw_mask_map_param_t6coordsE">
<span id="_CPPv3N25_lv_draw_mask_map_param_t6coordsE"></span><span id="_CPPv2N25_lv_draw_mask_map_param_t6coordsE"></span><span id="_lv_draw_mask_map_param_t::coords__lv_area_t"></span><span class="target" id="struct__lv__draw__mask__map__param__t_1afbdb3d7cc940685b61d31714edec9b1a"></span><span class="pre">lv_area_t</span> <code class="sig-name descname"><span class="pre">coords</span></code><a class="headerlink" href="#_CPPv4N25_lv_draw_mask_map_param_t6coordsE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N25_lv_draw_mask_map_param_t3mapE">
<span id="_CPPv3N25_lv_draw_mask_map_param_t3mapE"></span><span id="_CPPv2N25_lv_draw_mask_map_param_t3mapE"></span><span id="_lv_draw_mask_map_param_t::map__lv_opa_tCP"></span><span class="target" id="struct__lv__draw__mask__map__param__t_1a7b26095612ce13db58eedaf08e29cdfb"></span><em class="property"><span class="pre">const</span></em> <span class="pre">lv_opa_t</span> <span class="pre">*</span><code class="sig-name descname"><span class="pre">map</span></code><a class="headerlink" href="#_CPPv4N25_lv_draw_mask_map_param_t3mapE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N25_lv_draw_mask_map_param_t3cfgE">
<span id="_CPPv3N25_lv_draw_mask_map_param_t3cfgE"></span><span id="_CPPv2N25_lv_draw_mask_map_param_t3cfgE"></span><span class="target" id="struct__lv__draw__mask__map__param__t_1a0959bdc8c930292224773c9d3da0bf16"></span><em class="property"><span class="pre">struct</span></em> <a class="reference internal" href="#_CPPv425_lv_draw_mask_map_param_t" title="_lv_draw_mask_map_param_t"><span class="pre">_lv_draw_mask_map_param_t</span></a><span class="pre">::</span><strong><span class="pre">[anonymous]</span></strong> <code class="sig-name descname"><span class="pre">cfg</span></code><a class="headerlink" href="#_CPPv4N25_lv_draw_mask_map_param_t3cfgE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

</div>
</dd></dl>

<dl class="cpp struct">
<dt id="_CPPv421_lv_draw_mask_saved_t">
<span id="_CPPv321_lv_draw_mask_saved_t"></span><span id="_CPPv221_lv_draw_mask_saved_t"></span><span id="_lv_draw_mask_saved_t"></span><span class="target" id="struct__lv__draw__mask__saved__t"></span><em class="property"><span class="pre">struct</span> </em><code class="sig-name descname"><span class="pre">_lv_draw_mask_saved_t</span></code><a class="headerlink" href="#_CPPv421_lv_draw_mask_saved_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p>
<dl class="cpp var">
<dt id="_CPPv4N21_lv_draw_mask_saved_t5paramE">
<span id="_CPPv3N21_lv_draw_mask_saved_t5paramE"></span><span id="_CPPv2N21_lv_draw_mask_saved_t5paramE"></span><span id="_lv_draw_mask_saved_t::param__voidP"></span><span class="target" id="struct__lv__draw__mask__saved__t_1a6c9e743e6685ccf08976ec774c4baf61"></span><span class="pre">void</span> <span class="pre">*</span><code class="sig-name descname"><span class="pre">param</span></code><a class="headerlink" href="#_CPPv4N21_lv_draw_mask_saved_t5paramE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N21_lv_draw_mask_saved_t9custom_idE">
<span id="_CPPv3N21_lv_draw_mask_saved_t9custom_idE"></span><span id="_CPPv2N21_lv_draw_mask_saved_t9custom_idE"></span><span id="_lv_draw_mask_saved_t::custom_id__voidP"></span><span class="target" id="struct__lv__draw__mask__saved__t_1a361b363f337da4956912a15b2743e564"></span><span class="pre">void</span> <span class="pre">*</span><code class="sig-name descname"><span class="pre">custom_id</span></code><a class="headerlink" href="#_CPPv4N21_lv_draw_mask_saved_t9custom_idE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

</div>
</dd></dl>

</div>
</div>


           </div>
           
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="page.html" class="btn btn-neutral float-right" title="Page (lv_page)" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="msgbox.html" class="btn btn-neutral float-left" title="Message box (lv_msgbox)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        
        &copy; Copyright 2020, LVGL LLC
      <span class="lastupdated">
        Last updated on May 14, 2021.
      </span>

    </p>
  </div>
    
    
    
    Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
    
    <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
    
    provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
  

 <script type="text/javascript">
    $(document).ready(function() {
        $(".toggle > *").hide();
        $(".toggle .header").show();
        $(".toggle .header").click(function() {
            $(this).parent().children().not(".header").toggle(400);
            $(this).parent().children(".header").toggleClass("open");
        })
    });
</script>

<script type="text/javascript">
function add_version_selector()
{
    return fetch("https://raw.githubusercontent.com/lvgl/docs_compiled/gh-pages/versionlist.txt")
        .then(res => res.text())
        .then(text => {
            const versions = text.split("\n").filter(version => version.trim().length > 0);
            p = document.getElementById("rtd-search-form").parentElement;
            p.innerHTML = `
            <select name="versions" id="versions" onchange="ver_sel()" style="border-radius:5px; margin-bottom:15px">
            ${versions.map(version => `<option value="${version}">${version}</option>`)}
            </select>` + p.innerHTML;
        });
}

function ver_sel()
{
  var x = document.getElementById("versions").value;
  window.location.href = window.location.protocol + "//" + window.location.host + "/" + x + "/";
}

document.addEventListener('DOMContentLoaded', (event) => {
    add_version_selector().then(() => {
        var value = window.location.pathname.split('/')[1];
        document.getElementById("versions").value = value;
    });
    
})
</script>


</body>
</html>